{"components":{"schemas":{"APIKey":{"properties":{"api_key_id":{"readOnly":true,"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"key_prefix":{"readOnly":true,"type":"string"},"key_type":{"enum":["external"],"readOnly":true,"type":"string","x-enum-descriptions":["External."],"x-flint-enum":"closed"},"last_used_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"merchant_id":{"readOnly":true,"type":"string"},"name":{"type":"string"},"sandbox_id":{"readOnly":true,"type":"string"},"scopes":{"items":{"enum":["accounts.api_keys.read","accounts.api_keys.write","accounts.devices.read","accounts.devices.write","accounts.organizations.read","accounts.organizations.write","analytics.read","capabilities.read","checkouts.checkout_sessions.read","checkouts.checkout_sessions.write","checkouts.payment_links.read","checkouts.payment_links.write","commerce.bundles.read","commerce.bundles.write","commerce.catalog.read","commerce.catalog.write","commerce.credit_notes.read","commerce.credit_notes.write","commerce.delivery.read","commerce.delivery.write","commerce.inventory.read","commerce.inventory.write","commerce.inventory_locations.write","commerce.inventory_policies.write","commerce.inventory_reservations.write","commerce.invoices.read","commerce.invoices.write","commerce.orders.read","commerce.orders.write","commerce.products.read","commerce.products.write","commerce.promotions.read","commerce.promotions.write","commerce.refunds.read","commerce.refunds.tax_overrides.write","commerce.refunds.write","commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write","commerce.subscription_plans.read","commerce.subscription_plans.write","commerce.subscriptions.read","commerce.subscriptions.write","customers.read","customers.sessions.write","customers.write","developer.feedback_reports.read","developer.feedback_reports.write","developer.partner_apps.read","developer.partner_apps.write","developer.request_logs.self.detail.read","developer.request_logs.self.read","developer.resource_timelines.read","developer.sandboxes.read","developer.sandboxes.write","merchant_billing.read","merchants.account_sessions.write","merchants.locations.read","merchants.locations.write","merchants.onboarding.read","merchants.onboarding.write","merchants.profile.read","merchants.profile.write","money_movement.balance_transactions.read","money_movement.balances.read","money_movement.payout_settings.read","money_movement.payout_settings.write","money_movement.payouts.read","money_movement.payouts.write","payments.disputes.read","payments.payment_intents.read","payments.payment_intents.write","payments.payment_method_domains.read","payments.payment_method_domains.write","payments.payment_methods.read","payments.payment_methods.write","payments.payment_options.read","reports.read","reports.write","risk.controls.write","risk.read","risk.reviews.write","settings.read","settings.write","webhooks.read","webhooks.write"],"type":"string","x-enum-descriptions":["Accounts.api keys.read.","Accounts.api keys.write.","Accounts.devices.read.","Accounts.devices.write.","Accounts.organizations.read.","Accounts.organizations.write.","Analytics.read.","Capabilities.read.","Checkouts.checkout sessions.read.","Checkouts.checkout sessions.write.","Checkouts.payment links.read.","Checkouts.payment links.write.","Commerce.bundles.read.","Commerce.bundles.write.","Commerce.catalog.read.","Commerce.catalog.write.","Commerce.credit notes.read.","Commerce.credit notes.write.","Commerce.delivery.read.","Commerce.delivery.write.","Commerce.inventory.read.","Commerce.inventory.write.","Commerce.inventory locations.write.","Commerce.inventory policies.write.","Commerce.inventory reservations.write.","Commerce.invoices.read.","Commerce.invoices.write.","Commerce.orders.read.","Commerce.orders.write.","Commerce.products.read.","Commerce.products.write.","Commerce.promotions.read.","Commerce.promotions.write.","Commerce.refunds.read.","Commerce.refunds.tax overrides.write.","Commerce.refunds.write.","Commerce.return policies.write.","Commerce.return reasons.write.","Commerce.returns.decisions.write.","Commerce.returns.operations.write.","Commerce.returns.process.write.","Commerce.returns.read.","Commerce.returns.resolutions.write.","Commerce.returns.write.","Commerce.subscription plans.read.","Commerce.subscription plans.write.","Commerce.subscriptions.read.","Commerce.subscriptions.write.","Customers.read.","Customers.sessions.write.","Customers.write.","Developer.feedback reports.read.","Developer.feedback reports.write.","Developer.partner apps.read.","Developer.partner apps.write.","Developer.request logs.self.detail.read.","Developer.request logs.self.read.","Developer.resource timelines.read.","Developer.sandboxes.read.","Developer.sandboxes.write.","Merchant billing.read.","Merchants.account sessions.write.","Merchants.locations.read.","Merchants.locations.write.","Merchants.onboarding.read.","Merchants.onboarding.write.","Merchants.profile.read.","Merchants.profile.write.","Money movement.balance transactions.read.","Money movement.balances.read.","Money movement.payout settings.read.","Money movement.payout settings.write.","Money movement.payouts.read.","Money movement.payouts.write.","Payments.disputes.read.","Payments.payment intents.read.","Payments.payment intents.write.","Payments.payment method domains.read.","Payments.payment method domains.write.","Payments.payment methods.read.","Payments.payment methods.write.","Payments.payment options.read.","Reports.read.","Reports.write.","Risk.controls.write.","Risk.read.","Risk.reviews.write.","Settings.read.","Settings.write.","Webhooks.read.","Webhooks.write."],"x-flint-enum":"closed"},"type":"array"},"status":{"enum":["active","revoked"],"readOnly":true,"type":"string","x-enum-descriptions":["Active.","Revoked."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"}},"required":["api_key_id","key_prefix","key_type","name","scopes","status"],"type":"object"},"APIKeyListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/APIKey"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"APIKeyResponse":{"properties":{"data":{"$ref":"#/components/schemas/APIKey"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"APIKeyWithSecret":{"properties":{"api_key_id":{"readOnly":true,"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"key_prefix":{"readOnly":true,"type":"string"},"key_type":{"enum":["external"],"readOnly":true,"type":"string","x-enum-descriptions":["External."],"x-flint-enum":"closed"},"last_used_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"merchant_id":{"readOnly":true,"type":"string"},"name":{"type":"string"},"sandbox_id":{"readOnly":true,"type":"string"},"scopes":{"items":{"enum":["accounts.api_keys.read","accounts.api_keys.write","accounts.devices.read","accounts.devices.write","accounts.organizations.read","accounts.organizations.write","analytics.read","capabilities.read","checkouts.checkout_sessions.read","checkouts.checkout_sessions.write","checkouts.payment_links.read","checkouts.payment_links.write","commerce.bundles.read","commerce.bundles.write","commerce.catalog.read","commerce.catalog.write","commerce.credit_notes.read","commerce.credit_notes.write","commerce.delivery.read","commerce.delivery.write","commerce.inventory.read","commerce.inventory.write","commerce.inventory_locations.write","commerce.inventory_policies.write","commerce.inventory_reservations.write","commerce.invoices.read","commerce.invoices.write","commerce.orders.read","commerce.orders.write","commerce.products.read","commerce.products.write","commerce.promotions.read","commerce.promotions.write","commerce.refunds.read","commerce.refunds.tax_overrides.write","commerce.refunds.write","commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write","commerce.subscription_plans.read","commerce.subscription_plans.write","commerce.subscriptions.read","commerce.subscriptions.write","customers.read","customers.sessions.write","customers.write","developer.feedback_reports.read","developer.feedback_reports.write","developer.partner_apps.read","developer.partner_apps.write","developer.request_logs.self.detail.read","developer.request_logs.self.read","developer.resource_timelines.read","developer.sandboxes.read","developer.sandboxes.write","merchant_billing.read","merchants.account_sessions.write","merchants.locations.read","merchants.locations.write","merchants.onboarding.read","merchants.onboarding.write","merchants.profile.read","merchants.profile.write","money_movement.balance_transactions.read","money_movement.balances.read","money_movement.payout_settings.read","money_movement.payout_settings.write","money_movement.payouts.read","money_movement.payouts.write","payments.disputes.read","payments.payment_intents.read","payments.payment_intents.write","payments.payment_method_domains.read","payments.payment_method_domains.write","payments.payment_methods.read","payments.payment_methods.write","payments.payment_options.read","reports.read","reports.write","risk.controls.write","risk.read","risk.reviews.write","settings.read","settings.write","webhooks.read","webhooks.write"],"type":"string","x-enum-descriptions":["Accounts.api keys.read.","Accounts.api keys.write.","Accounts.devices.read.","Accounts.devices.write.","Accounts.organizations.read.","Accounts.organizations.write.","Analytics.read.","Capabilities.read.","Checkouts.checkout sessions.read.","Checkouts.checkout sessions.write.","Checkouts.payment links.read.","Checkouts.payment links.write.","Commerce.bundles.read.","Commerce.bundles.write.","Commerce.catalog.read.","Commerce.catalog.write.","Commerce.credit notes.read.","Commerce.credit notes.write.","Commerce.delivery.read.","Commerce.delivery.write.","Commerce.inventory.read.","Commerce.inventory.write.","Commerce.inventory locations.write.","Commerce.inventory policies.write.","Commerce.inventory reservations.write.","Commerce.invoices.read.","Commerce.invoices.write.","Commerce.orders.read.","Commerce.orders.write.","Commerce.products.read.","Commerce.products.write.","Commerce.promotions.read.","Commerce.promotions.write.","Commerce.refunds.read.","Commerce.refunds.tax overrides.write.","Commerce.refunds.write.","Commerce.return policies.write.","Commerce.return reasons.write.","Commerce.returns.decisions.write.","Commerce.returns.operations.write.","Commerce.returns.process.write.","Commerce.returns.read.","Commerce.returns.resolutions.write.","Commerce.returns.write.","Commerce.subscription plans.read.","Commerce.subscription plans.write.","Commerce.subscriptions.read.","Commerce.subscriptions.write.","Customers.read.","Customers.sessions.write.","Customers.write.","Developer.feedback reports.read.","Developer.feedback reports.write.","Developer.partner apps.read.","Developer.partner apps.write.","Developer.request logs.self.detail.read.","Developer.request logs.self.read.","Developer.resource timelines.read.","Developer.sandboxes.read.","Developer.sandboxes.write.","Merchant billing.read.","Merchants.account sessions.write.","Merchants.locations.read.","Merchants.locations.write.","Merchants.onboarding.read.","Merchants.onboarding.write.","Merchants.profile.read.","Merchants.profile.write.","Money movement.balance transactions.read.","Money movement.balances.read.","Money movement.payout settings.read.","Money movement.payout settings.write.","Money movement.payouts.read.","Money movement.payouts.write.","Payments.disputes.read.","Payments.payment intents.read.","Payments.payment intents.write.","Payments.payment method domains.read.","Payments.payment method domains.write.","Payments.payment methods.read.","Payments.payment methods.write.","Payments.payment options.read.","Reports.read.","Reports.write.","Risk.controls.write.","Risk.read.","Risk.reviews.write.","Settings.read.","Settings.write.","Webhooks.read.","Webhooks.write."],"x-flint-enum":"closed"},"type":"array"},"secret_key":{"type":"string"},"status":{"enum":["active","revoked"],"readOnly":true,"type":"string","x-enum-descriptions":["Active.","Revoked."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"}},"required":["api_key_id","key_prefix","key_type","name","scopes","secret_key","status"],"type":"object"},"APIRequestLog":{"properties":{"api_request_log_id":{"type":"string"},"correlation_id":{"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"error_category":{"enum":["authentication","authorization","validation","server_error","rate_limit","idempotency","merchant_readiness","payment","request_error","webhook_timeout","webhook_dns","webhook_tls","webhook_connection","webhook_blocked_target","webhook_request","webhook_http_5xx","webhook_http_4xx","webhook_delivery"],"type":"string","x-enum-descriptions":["Authentication.","Authorization.","Validation.","Server error.","Rate limit.","Idempotency.","Merchant readiness.","Payment.","Request error.","Webhook timeout.","Webhook dns.","Webhook tls.","Webhook connection.","Webhook blocked target.","Webhook request.","Webhook http 5xx.","Webhook http 4xx.","Webhook delivery."],"x-flint-enum":"closed"},"error_code":{"type":"string"},"error_summary":{"type":"string"},"http_method":{"type":"string"},"latency_milliseconds":{"format":"int64","type":"integer"},"path":{"type":"string"},"recommended_action":{"type":"string"},"reference_url":{"type":"string"},"request_id":{"type":"string"},"requested_api_version":{"type":"string"},"requested_api_version_source":{"enum":["header","partner_app","merchant","current"],"type":"string","x-enum-descriptions":["Header.","Partner app.","Merchant.","Current."],"x-flint-enum":"closed"},"resource_id":{"type":"string"},"resource_type":{"type":"string"},"response_shape_metadata":{"$ref":"#/components/schemas/ApiRequestLogResponseShapeMetadata"},"retryable":{"type":"boolean"},"route_pattern":{"type":"string"},"served_api_version":{"type":"string"},"status_code":{"format":"int32","type":"integer"}},"required":["api_request_log_id","created_at","http_method","latency_milliseconds","path","request_id","route_pattern","status_code"],"type":"object"},"APIRequestLogDetail":{"properties":{"api_request_log_id":{"type":"string"},"correlation_id":{"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"error_category":{"enum":["authentication","authorization","validation","server_error","rate_limit","idempotency","merchant_readiness","payment","request_error","webhook_timeout","webhook_dns","webhook_tls","webhook_connection","webhook_blocked_target","webhook_request","webhook_http_5xx","webhook_http_4xx","webhook_delivery"],"type":"string","x-enum-descriptions":["Authentication.","Authorization.","Validation.","Server error.","Rate limit.","Idempotency.","Merchant readiness.","Payment.","Request error.","Webhook timeout.","Webhook dns.","Webhook tls.","Webhook connection.","Webhook blocked target.","Webhook request.","Webhook http 5xx.","Webhook http 4xx.","Webhook delivery."],"x-flint-enum":"closed"},"error_code":{"type":"string"},"error_summary":{"type":"string"},"http_method":{"type":"string"},"latency_milliseconds":{"format":"int64","type":"integer"},"path":{"type":"string"},"query_params":{"items":{"$ref":"#/components/schemas/APIRequestLogQueryParam"},"type":"array"},"recommended_action":{"type":"string"},"reference_url":{"type":"string"},"reproduction":{"$ref":"#/components/schemas/APIRequestLogReproduction"},"request_body":{"type":"string"},"request_headers":{"type":"string"},"request_id":{"type":"string"},"requested_api_version":{"type":"string"},"requested_api_version_source":{"enum":["header","partner_app","merchant","current"],"type":"string","x-enum-descriptions":["Header.","Partner app.","Merchant.","Current."],"x-flint-enum":"closed"},"resource_id":{"type":"string"},"resource_type":{"type":"string"},"response_body":{"type":"string"},"response_content_type":{"type":"string"},"response_shape_metadata":{"$ref":"#/components/schemas/ApiRequestLogResponseShapeMetadata"},"retryable":{"type":"boolean"},"route_pattern":{"type":"string"},"served_api_version":{"type":"string"},"status_code":{"format":"int32","type":"integer"}},"required":["api_request_log_id","created_at","http_method","latency_milliseconds","path","query_params","reproduction","request_id","route_pattern","status_code"],"type":"object"},"APIRequestLogDetailResponse":{"properties":{"data":{"$ref":"#/components/schemas/APIRequestLogDetail"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"APIRequestLogListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/APIRequestLog"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"APIRequestLogQueryParam":{"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"],"type":"object"},"APIRequestLogReproduction":{"properties":{"body":{"type":"string"},"curl":{"type":"string"},"headers":{"additionalProperties":{"type":"string"},"type":"object"},"http_method":{"type":"string"},"path":{"type":"string"},"query_params":{"items":{"$ref":"#/components/schemas/APIRequestLogQueryParam"},"type":"array"},"recommended_environment":{"type":"string"},"redactions_present":{"type":"boolean"},"reproduction_complete":{"type":"boolean"},"safe_to_reproduce":{"type":"boolean"},"warnings":{"items":{"type":"string"},"type":"array"}},"required":["curl","headers","http_method","path","query_params","recommended_environment","redactions_present","reproduction_complete","safe_to_reproduce"],"type":"object"},"ActionResponse":{"properties":{"data":{"$ref":"#/components/schemas/ActionResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ActionResult":{"properties":{"success":{"type":"boolean"}},"required":["success"],"type":"object"},"AddLineItemsRequest":{"additionalProperties":false,"properties":{"line_items":{"items":{"$ref":"#/components/schemas/CreateOrderLineItem"},"minItems":1,"type":"array"}},"required":["line_items"],"type":"object"},"AddOrderChargeRequest":{"properties":{"charge":{"$ref":"#/components/schemas/OrderChargeInput"}},"required":["charge"],"type":"object"},"AddReturnLineItemRequest":{"additionalProperties":false,"properties":{"expected_version":{"format":"int64","minimum":1,"type":"integer"},"line_item":{"$ref":"#/components/schemas/ReturnLineItemInput"}},"required":["line_item"],"type":"object"},"AddReturnLineItemResponse":{"properties":{"data":{"$ref":"#/components/schemas/Return"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"AddRiskListItemsRequest":{"oneOf":[{"not":{"required":["values"]},"required":["value"]},{"not":{"required":["value"]},"required":["values"]}],"properties":{"value":{"maxLength":512,"minLength":1,"type":"string"},"values":{"items":{"maxLength":512,"minLength":1,"type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["values"],"type":"object"},"Address":{"properties":{"city":{"type":"string"},"country":{"description":"ISO 3166-1 alpha-2 country code.","example":"US","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"line1":{"type":"string"},"line2":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}},"required":["city","country","line1","postal_code","state"],"type":"object"},"AdjustmentLine":{"properties":{"damaged_quantity_delta":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"inventory_item_id":{"type":"string"},"inventory_movement_id":{"type":"string"},"location_id":{"type":"string"},"on_hand_quantity_delta":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"quality_control_quantity_delta":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"quarantined_quantity_delta":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"}},"required":["inventory_item_id","inventory_movement_id","location_id"],"type":"object"},"Analysis":{"properties":{"applicability":{"enum":["all_payments","on_session_only"],"type":"string","x-enum-descriptions":["All payments.","On session only."],"x-flint-enum":"closed"},"attributes_used":{"items":{"type":"string"},"type":"array"},"list_aliases_used":{"items":{"type":"string"},"type":"array"},"stage":{"enum":["pre_authorization","post_authorization"],"type":"string","x-enum-descriptions":["Pre authorization.","Post authorization."],"x-flint-enum":"closed"}},"required":["applicability","attributes_used","stage"],"type":"object"},"AnalyticsOverview":{"properties":{"active_subscriptions":{"$ref":"#/components/schemas/CountMetric"},"average_payment":{"$ref":"#/components/schemas/MoneyMetric"},"currencies":{"items":{"type":"string"},"type":"array"},"gross_volume":{"$ref":"#/components/schemas/MoneyMetric"},"has_multiple_currencies":{"type":"boolean"},"net_volume":{"$ref":"#/components/schemas/MoneyMetric"},"new_customers":{"$ref":"#/components/schemas/CountMetric"},"payments_count":{"$ref":"#/components/schemas/CountMetric"},"range":{"enum":["today","last_7_days","last_30_days"],"type":"string","x-enum-descriptions":["Today.","Last 7 days.","Last 30 days."],"x-flint-enum":"closed"},"refunds_total":{"$ref":"#/components/schemas/MoneyMetric"},"timezone":{"type":"string"}},"required":["active_subscriptions","average_payment","gross_volume","has_multiple_currencies","net_volume","new_customers","payments_count","range","refunds_total","timezone"],"type":"object"},"AnalyticsOverviewResponse":{"properties":{"data":{"$ref":"#/components/schemas/AnalyticsOverview"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ApiRequestLogExpansionShape":{"properties":{"path":{"type":"string"},"shape":{"type":"string"}},"required":["path","shape"],"type":"object"},"ApiRequestLogResponseShapeMetadata":{"properties":{"auth_mode":{"type":"string"},"expansion_shapes":{"items":{"$ref":"#/components/schemas/ApiRequestLogExpansionShape"},"type":"array"},"normalized_expand_paths":{"items":{"type":"string"},"type":"array"},"response_shape_key":{"type":"string"}},"required":["auth_mode","expansion_shapes","normalized_expand_paths","response_shape_key"],"type":"object"},"AppliedDiscount":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"applied_money":{"$ref":"#/components/schemas/Money"},"customer_facing_name":{"type":"string"},"discount_class":{"enum":["order","line_item","service_charge"],"type":"string","x-enum-descriptions":["Order.","Line item.","Service charge."],"x-flint-enum":"closed"},"order_charge_ids":{"items":{"type":"string"},"type":"array"},"order_discount_id":{"description":"Identifier for this applied discount, unique within the order and with no prefix. Pass it to POST /v1/orders/{order_id}/discounts/remove to remove the discount.","type":"string"},"order_id":{"type":"string"},"order_line_item_ids":{"items":{"type":"string"},"type":"array"},"promotion_code":{"description":"Promotion code used to create this discount. Present only when source is promotion and a code was used.","type":"string"},"promotion_id":{"description":"Promotion that created this discount. Present only when source is promotion.","type":"string"},"source":{"enum":["manual","promotion"],"type":"string","x-enum-descriptions":["Manual.","Promotion."],"x-flint-enum":"closed"},"status":{"enum":["pending","redeemed","canceled"],"type":"string","x-enum-descriptions":["Pending.","Redeemed.","Canceled."],"x-flint-enum":"open"}},"required":["amount_money","applied_money","order_discount_id","order_id","status"],"type":"object"},"ApplyDiscountRequest":{"oneOf":[{"not":{"anyOf":[{"required":["manual"]}]},"required":["promotion"]},{"not":{"anyOf":[{"required":["promotion"]}]},"required":["manual"]}],"properties":{"manual":{"$ref":"#/components/schemas/ManualDiscountInput"},"promotion":{"$ref":"#/components/schemas/PromotionRefInput"}},"type":"object"},"AssessInvoiceLateFeeRequest":{"properties":{"invoice_schedule_entry_id":{"type":"string"}},"type":"object"},"AssignToUnconfiguredDeliveryProfileRequest":{"additionalProperties":false,"properties":{"expected_catalog_default_version":{"description":"Optional catalog settings version. When provided, the profile must still be the current catalog default.","format":"uint64","minimum":1,"type":"integer"},"expected_version":{"description":"Current version of the delivery profile.","format":"uint64","minimum":1,"type":"integer"}},"type":"object"},"AvailableModifier":{"properties":{"default_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"line_item_tax_category":{"description":"Flint line-item tax category.","enum":["general","physical_goods","digital_goods","software","saas","services","professional_services","food","prepared_food","clothing","medical_goods","admission"],"type":"string","x-enum-descriptions":["General.","Physical goods.","Digital goods.","Software.","Saas.","Services.","Professional services.","Food.","Prepared food.","Clothing.","Medical goods.","Admission."],"x-flint-enum":"closed"},"modifier_id":{"type":"string"},"name":{"type":"string"},"position":{"format":"int32","type":"integer"},"selected_by_default":{"type":"boolean"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"taxable":{"type":"boolean"},"unit_price_delta_money":{"$ref":"#/components/schemas/Money"}},"required":["modifier_id","name","position","selected_by_default","show_on_fulfillment","show_on_receipt"],"type":"object"},"AvailableModifierGroup":{"properties":{"modifier_group_id":{"type":"string"},"modifier_group_type":{"enum":["list","text"],"type":"string","x-enum-descriptions":["List.","Text."],"x-flint-enum":"closed"},"modifiers":{"items":{"$ref":"#/components/schemas/AvailableModifier"},"type":"array"},"name":{"type":"string"},"position":{"format":"int32","type":"integer"},"selection":{"$ref":"#/components/schemas/AvailableModifierSelection"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"text":{"$ref":"#/components/schemas/AvailableTextModifierConfig"}},"required":["modifier_group_id","modifier_group_type","name","position","show_on_fulfillment","show_on_receipt"],"type":"object"},"AvailableModifierSelection":{"properties":{"allow_quantities":{"type":"boolean"},"max_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"max_selected":{"format":"int32","type":"integer"},"max_total_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"min_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"min_selected":{"format":"int32","type":"integer"}},"required":["allow_quantities"],"type":"object"},"AvailableTextModifierConfig":{"properties":{"max_length":{"format":"int32","type":"integer"},"min_length":{"format":"int32","type":"integer"},"multiline":{"type":"boolean"},"required":{"type":"boolean"}},"required":["multiline","required"],"type":"object"},"Balance":{"properties":{"available_by_source_type":{"additionalProperties":{"$ref":"#/components/schemas/SignedMoney"},"readOnly":true,"type":"object"},"available_money":{"$ref":"#/components/schemas/SignedMoney","readOnly":true},"balance_id":{"readOnly":true,"type":"string"},"currency":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","readOnly":true,"type":"string"},"held_by_type":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"readOnly":true,"type":"object"},"held_money":{"$ref":"#/components/schemas/Money","readOnly":true},"merchant_id":{"readOnly":true,"type":"string"},"payouts_enabled":{"readOnly":true,"type":"boolean"},"pending_by_source_type":{"additionalProperties":{"$ref":"#/components/schemas/SignedMoney"},"readOnly":true,"type":"object"},"pending_money":{"$ref":"#/components/schemas/SignedMoney","readOnly":true},"reserve_money":{"$ref":"#/components/schemas/Money","readOnly":true},"unavailable_money":{"$ref":"#/components/schemas/Money","readOnly":true}},"required":["available_money","balance_id","currency","held_money","merchant_id","payouts_enabled","pending_money","reserve_money","unavailable_money"],"type":"object"},"BalanceListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Balance"},"type":"array"},"meta":{"$ref":"#/components/schemas/MoneyMovementListMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"BalanceTransaction":{"properties":{"amount_money":{"$ref":"#/components/schemas/SignedMoney","description":"Signed gross amount of this balance movement, before any fee.","readOnly":true},"available_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"balance_transaction_id":{"readOnly":true,"type":"string"},"currency":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"fee_money":{"$ref":"#/components/schemas/SignedMoney","description":"Flint fee for this balance movement, never a provider cost passed through. Charges are positive; returned fees are negative. A payment of 5000 with a fee of 175 has a net amount of 4825. A payout reversal returning a fee of 25 reports fee_money -25.","readOnly":true},"hold_detail":{"$ref":"#/components/schemas/HoldDetail","readOnly":true},"merchant_id":{"readOnly":true,"type":"string"},"net_money":{"$ref":"#/components/schemas/SignedMoney","description":"Signed net effect on your Flint balance: amount_money minus fee_money in the same currency.","readOnly":true},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"order":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrderSummary"},{"type":"null"}]},"order_id":{"readOnly":true,"type":"string"},"related_balance_transaction_ids":{"items":{"type":"string"},"readOnly":true,"type":"array"},"related_resource":{"$ref":"#/components/schemas/BalanceTransactionRelatedResource","readOnly":true},"status":{"enum":["pending","available","reserved","reversed","failed","superseded"],"readOnly":true,"type":"string","x-enum-descriptions":["Pending.","Available.","Reserved.","Reversed.","Failed.","Superseded."],"x-flint-enum":"open"},"type":{"enum":["payment","refund","dispute","dispute_reversal","return","recovery","payout","payout_failure","payout_cancellation","payout_reversal","payout_advance","payout_advance_funding","reserve_hold","reserve_release","payout_hold","payout_hold_release","adjustment","merchant_billing_payment","merchant_billing_payment_reversal"],"readOnly":true,"type":"string","x-enum-descriptions":["Payment.","Refund.","Dispute.","Dispute reversal.","Return.","Recovery.","Payout.","Payout failure.","Payout cancellation.","Payout reversal.","Payout advance.","Payout advance funding.","Reserve hold.","Reserve release.","Payout hold.","Payout hold release.","Adjustment.","Merchant billing payment.","Merchant billing payment reversal."],"x-flint-enum":"closed"}},"required":["amount_money","balance_transaction_id","currency","fee_money","merchant_id","net_money","occurred_at","status","type"],"type":"object"},"BalanceTransactionListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/BalanceTransaction"},"type":"array"},"meta":{"$ref":"#/components/schemas/MoneyMovementListMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"BalanceTransactionRelatedResource":{"discriminator":{"propertyName":"type"},"oneOf":[{"additionalProperties":false,"properties":{"payment_intent_id":{"type":"string"},"type":{"enum":["payment_intent"],"type":"string","x-enum-descriptions":["Payment intent."],"x-flint-enum":"closed"}},"required":["type","payment_intent_id"],"type":"object"},{"additionalProperties":false,"properties":{"refund_id":{"type":"string"},"type":{"enum":["refund"],"type":"string","x-enum-descriptions":["Refund."],"x-flint-enum":"closed"}},"required":["type","refund_id"],"type":"object"},{"additionalProperties":false,"properties":{"dispute_id":{"type":"string"},"type":{"enum":["dispute"],"type":"string","x-enum-descriptions":["Dispute."],"x-flint-enum":"closed"}},"required":["type","dispute_id"],"type":"object"},{"additionalProperties":false,"properties":{"payout_id":{"type":"string"},"type":{"enum":["payout"],"type":"string","x-enum-descriptions":["Payout."],"x-flint-enum":"closed"}},"required":["type","payout_id"],"type":"object"},{"additionalProperties":false,"properties":{"payout_destination_id":{"type":"string"},"type":{"enum":["payout_destination"],"type":"string","x-enum-descriptions":["Payout destination."],"x-flint-enum":"closed"}},"required":["type","payout_destination_id"],"type":"object"},{"additionalProperties":false,"properties":{"merchant_subscription_invoice_id":{"type":"string"},"type":{"enum":["merchant_subscription_invoice"],"type":"string","x-enum-descriptions":["Merchant subscription invoice."],"x-flint-enum":"closed"}},"required":["type","merchant_subscription_invoice_id"],"type":"object"}],"type":"object"},"BalanceTransactionResponse":{"properties":{"data":{"$ref":"#/components/schemas/BalanceTransaction"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"Banner":{"properties":{"action_href":{"type":"string"},"action_label":{"type":"string"},"dismissible_id":{"type":"string"},"message":{"type":"string"},"style":{"enum":["info","warning","error","success"],"type":"string","x-enum-descriptions":["Info.","Warning.","Error.","Success."],"x-flint-enum":"closed"}},"required":["message","style"],"type":"object"},"BrandingSettings":{"properties":{"accent_color":{"type":"string"},"background_color":{"type":"string"},"corner_radius":{"format":"int32","type":"integer"},"font_family":{"enum":["instrument_sans","system_sans","system_serif","monospace"],"type":"string","x-enum-descriptions":["Instrument sans.","System sans.","System serif.","Monospace."],"x-flint-enum":"closed"},"primary_color":{"type":"string"},"text_color":{"type":"string"}},"type":"object"},"Bundle":{"properties":{"available_for_sale":{"readOnly":true,"type":"boolean"},"barcode":{"type":"string"},"bundle_id":{"readOnly":true,"type":"string"},"categories":{"items":{"$ref":"#/components/schemas/CategoryReference"},"type":"array"},"component_count":{"description":"Number of components in the bundle. List responses omit `components`, so use this to show a bundle's size.","format":"int32","readOnly":true,"type":"integer"},"components":{"items":{"$ref":"#/components/schemas/BundleComponent"},"type":"array"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"delivery_configuration_status":{"enum":["configured","action_required","not_applicable"],"readOnly":true,"type":"string","x-enum-descriptions":["Configured.","Action required.","Not applicable."],"x-flint-enum":"open"},"description":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"images":{"items":{"$ref":"#/components/schemas/Image"},"type":"array"},"line_item_tax_category":{"description":"Flint line-item tax category.","enum":["general","physical_goods","digital_goods","software","saas","services","professional_services","food","prepared_food","clothing","medical_goods","admission"],"type":"string","x-enum-descriptions":["General.","Physical goods.","Digital goods.","Software.","Saas.","Services.","Professional services.","Food.","Prepared food.","Clothing.","Medical goods.","Admission."],"x-flint-enum":"closed"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"modifier_set":{"anyOf":[{"$ref":"#/components/schemas/ModifierSet"},{"type":"null"}],"readOnly":true},"modifier_set_id":{"description":"Attached modifier set. Send null on update to remove it.","pattern":"^ms_[0-9A-HJKMNP-TV-Z]{26}$","type":["string","null"]},"name":{"type":"string"},"sku":{"type":"string"},"status":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"},"taxable":{"type":"boolean"},"unit_price_money":{"$ref":"#/components/schemas/Money"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"version":{"format":"uint64","minimum":0,"readOnly":true,"type":"integer"}},"required":["available_for_sale","bundle_id","component_count","delivery_configuration_status","images","modifier_set_id","name","status","unit_price_money","version"],"type":"object"},"BundleComponent":{"properties":{"bundle_component_id":{"readOnly":true,"type":"string"},"current_delivery_profile_revision_id":{"readOnly":true,"type":"string"},"delivery_configuration_reason":{"enum":["delivery_profile_missing","delivery_profile_inactive"],"readOnly":true,"type":"string","x-enum-descriptions":["Delivery profile missing.","Delivery profile inactive."],"x-flint-enum":"closed"},"delivery_configuration_status":{"enum":["configured","action_required","not_applicable"],"readOnly":true,"type":"string","x-enum-descriptions":["Configured.","Action required.","Not applicable."],"x-flint-enum":"open"},"delivery_profile_id":{"type":"string"},"position":{"format":"int32","type":"integer"},"product_id":{"readOnly":true,"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","type":"integer"},"variant":{"$ref":"#/components/schemas/BundleComponentVariantSummary","readOnly":true},"variant_id":{"type":"string"}},"required":["bundle_component_id","delivery_configuration_status","position","quantity","variant_id"],"type":"object"},"BundleComponentListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/BundleComponent"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"BundleComponentVariantSummary":{"properties":{"available_for_sale":{"type":"boolean"},"name":{"type":"string"},"product_name":{"description":"Name of the product the variant belongs to.","type":"string"},"selected_options":{"items":{"$ref":"#/components/schemas/SelectedProductOption"},"type":"array"},"sku":{"type":"string"},"variant_id":{"type":"string"}},"required":["available_for_sale","variant_id"],"type":"object"},"BundleListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Bundle"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"BundleResponse":{"properties":{"data":{"$ref":"#/components/schemas/Bundle"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"BuyerCreditNote":{"description":"The buyer-visible view of a credit note. Drafts are never returned, and how much credit is left to allocate is omitted.","properties":{"buyer_tax_identity":{"anyOf":[{"$ref":"#/components/schemas/TaxIdentity"},{"type":"null"}],"description":"Identity frozen on the source invoice at issue. Later profile edits do not change this document.","readOnly":true},"credit_note_id":{"type":"string"},"credit_note_lines":{"items":{"$ref":"#/components/schemas/CreditNoteLine"},"type":"array"},"credit_note_number":{"description":"Assigned at issue and stable from then on. Absent while the credit note is a draft.","type":"string"},"invoice_id":{"type":"string"},"issued_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"latest_refund_status":{"enum":["pending","in_transit","succeeded","failed","requires_action","canceled","partially_succeeded"],"type":"string","x-enum-descriptions":["Pending.","In transit.","Succeeded.","Failed.","Requires action.","Canceled.","Partially succeeded."],"x-flint-enum":"open"},"memo":{"type":"string"},"pending_refund_money":{"$ref":"#/components/schemas/Money"},"reason":{"description":"Why the invoice is being corrected. Shown on the credit note document.","enum":["returned_goods","order_adjustment","billing_error","goodwill","other"],"type":"string","x-enum-descriptions":["Returned goods.","Order adjustment.","Billing error.","Goodwill.","Other."],"x-flint-enum":"closed"},"refunded_money":{"$ref":"#/components/schemas/Money"},"seller_tax_identity":{"anyOf":[{"$ref":"#/components/schemas/TaxIdentity"},{"type":"null"}],"description":"Identity frozen on the source invoice at issue. Later profile edits do not change this document.","readOnly":true},"status":{"description":"draft while the credit note is editable, issued once it is numbered and frozen, void once retired.","enum":["issued","void"],"type":"string","x-enum-descriptions":["Issued.","Void."],"x-flint-enum":"open"},"total_money":{"$ref":"#/components/schemas/Money","description":"The face value of the credit note, the sum of its lines."},"voided_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["credit_note_id","credit_note_lines","credit_note_number","invoice_id","issued_at","pending_refund_money","reason","refunded_money","status","total_money"],"type":"object"},"BuyerCreditNoteListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/BuyerCreditNote"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"BuyerCreditNoteResponse":{"properties":{"data":{"$ref":"#/components/schemas/BuyerCreditNote"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"BuyerDeliveryInputRequirementResource":{"properties":{"constraint":{"$ref":"#/components/schemas/DeliveryInputConstraint"},"delivery_choice_group_ids":{"items":{"type":"string"},"type":"array"},"delivery_input_requirement_id":{"type":"string"},"delivery_option_ids":{"items":{"type":"string"},"type":"array"},"field_path":{"type":"string"},"purpose":{"type":"string"}},"required":["constraint","delivery_input_requirement_id","field_path","purpose"],"type":"object"},"BuyerDeliveryOptionResource":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"arrival_estimate":{"$ref":"#/components/schemas/DeliveryArrivalEstimate"},"buyer_instructions":{"$ref":"#/components/schemas/BuyerInstructionsConfig"},"consumed_by_delivery_selection_id":{"type":"string"},"delivery_method_id":{"type":"string"},"delivery_option_id":{"type":"string"},"delivery_plan":{"$ref":"#/components/schemas/DeliveryPlan"},"description":{"type":"string"},"display_position":{"format":"int32","type":"integer"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"local_delivery":{"$ref":"#/components/schemas/DeliveryLocalDeliveryDetails"},"name":{"type":"string"},"offered_windows":{"items":{"$ref":"#/components/schemas/DeliveryWindowResource"},"type":"array"},"pickup":{"$ref":"#/components/schemas/DeliveryPickupDetails"},"recipient_requirements":{"items":{"$ref":"#/components/schemas/DeliveryRecipientRequirement"},"type":"array"},"recommended":{"type":"boolean"},"shipment":{"$ref":"#/components/schemas/DeliveryShipmentDetails"},"taxable":{"type":"boolean"},"timezone":{"type":"string"},"type":{"enum":["shipment","pickup","local_delivery"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery."],"x-flint-enum":"closed"},"window_end_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"window_pricing":{"enum":["uniform","varies"],"type":"string","x-enum-descriptions":["Uniform.","Varies."],"x-flint-enum":"closed"},"window_selection":{"enum":["none","offered"],"type":"string","x-enum-descriptions":["None.","Offered."],"x-flint-enum":"closed"},"window_start_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["amount_money","buyer_instructions","delivery_method_id","delivery_plan","display_position","name","recommended","taxable","type","window_selection"],"type":"object"},"BuyerDeliveryQuote":{"properties":{"audience":{"const":"buyer","type":"string"},"buyer_location":{"$ref":"#/components/schemas/DeliveryBuyerLocationResource"},"buyer_reasons":{"description":"Buyer-safe reasons no delivery option was available. Merchant configuration details are never included.","items":{"enum":["address_required","address_incomplete","outside_delivery_area","no_pickup_location_nearby","unavailable_for_these_items","temporarily_unavailable"],"type":"string","x-enum-descriptions":["Address required.","Address incomplete.","Outside delivery area.","No pickup location nearby.","Unavailable for these items.","Temporarily unavailable."],"x-flint-enum":"closed"},"type":"array"},"choice_groups":{"items":{"$ref":"#/components/schemas/BuyerDeliveryQuoteChoiceGroupResource"},"type":"array"},"delivery_quote_id":{"type":"string"},"destination_address":{"$ref":"#/components/schemas/DeliveryAddressResource"},"evaluated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"evaluation_status":{"enum":["complete","incomplete","degraded"],"type":"string","x-enum-descriptions":["Complete.","Incomplete.","Degraded."],"x-flint-enum":"open"},"expires_at":{"description":"Authoritative expiry for this quote. It can be shorter than the platform maximum because inventory and checkout deadlines also apply. Read this value from every response.","format":"date-time","type":"string"},"input_requirements":{"items":{"$ref":"#/components/schemas/BuyerDeliveryInputRequirementResource"},"type":"array"},"selection_required":{"type":"boolean"},"status":{"enum":["active","consumed","stale","expired","revoked"],"type":"string","x-enum-descriptions":["Active.","Consumed.","Stale.","Expired.","Revoked."],"x-flint-enum":"open"}},"required":["audience","buyer_reasons","choice_groups","delivery_quote_id","evaluated_at","evaluation_status","expires_at","input_requirements","selection_required","status"],"type":"object"},"BuyerDeliveryQuoteChoiceGroupResource":{"properties":{"address_advisories":{"description":"Buyer-actionable address verification results that affected this choice group. A suggested_address is an explicit correction the buyer may confirm; Flint does not apply it silently.","items":{"$ref":"#/components/schemas/DeliveryAddressAdvisoryResource"},"type":"array"},"availability_status":{"enum":["ready","needs_input","needs_checkout_context","unavailable"],"type":"string","x-enum-descriptions":["Ready.","Needs input.","Needs checkout context.","Unavailable."],"x-flint-enum":"open"},"delivery_choice_group_id":{"type":"string"},"evaluation_status":{"enum":["complete","incomplete","degraded"],"type":"string","x-enum-descriptions":["Complete.","Incomplete.","Degraded."],"x-flint-enum":"open"},"input_requirements":{"items":{"$ref":"#/components/schemas/BuyerDeliveryInputRequirementResource"},"type":"array"},"line_items":{"items":{"$ref":"#/components/schemas/DeliveryQuoteLineItemResource"},"type":"array"},"options":{"items":{"$ref":"#/components/schemas/BuyerDeliveryOptionResource"},"type":"array"},"previously_selected_delivery_method_id":{"type":"string"},"stable_key":{"type":"string"}},"required":["availability_status","delivery_choice_group_id","evaluation_status","input_requirements","line_items","options","stable_key"],"type":"object"},"BuyerDeliverySelection":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"choices":{"items":{"$ref":"#/components/schemas/BuyerDeliverySelectionChoiceResource"},"type":"array"},"delivery_quote_id":{"type":"string"},"delivery_selection_id":{"type":"string"},"destination_address":{"$ref":"#/components/schemas/DeliveryAddressResource"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"recipient":{"$ref":"#/components/schemas/DeliveryRecipientResource"},"status":{"enum":["selected","locked_for_payment","committed","superseded","expired","released"],"type":"string","x-enum-descriptions":["Selected.","Locked for payment.","Committed.","Superseded.","Expired.","Released."],"x-flint-enum":"open"}},"required":["amount_money","choices","delivery_quote_id","delivery_selection_id","expires_at","status"],"type":"object"},"BuyerDeliverySelectionChoiceResource":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"delivery_choice_group_id":{"type":"string"},"delivery_method_id":{"type":"string"},"delivery_option_id":{"type":"string"},"delivery_plan":{"$ref":"#/components/schemas/DeliveryPlan"},"delivery_window_id":{"type":"string"},"description":{"type":"string"},"input":{"$ref":"#/components/schemas/DeliverySelectionInstructionsInput"},"local_delivery":{"$ref":"#/components/schemas/DeliveryLocalDeliveryDetails"},"name":{"type":"string"},"pickup":{"$ref":"#/components/schemas/DeliveryPickupDetails"},"shipment":{"$ref":"#/components/schemas/DeliveryShipmentDetails"},"stable_key":{"type":"string"},"timezone":{"description":"IANA timezone for displaying window_start_at and window_end_at.","example":"America/New_York","type":"string"},"total_money":{"$ref":"#/components/schemas/Money"},"type":{"enum":["shipment","pickup","local_delivery"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery."],"x-flint-enum":"closed"},"window_end_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"window_start_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["amount_money","delivery_choice_group_id","delivery_method_id","delivery_option_id","delivery_plan","name","stable_key","total_money","type"],"type":"object"},"BuyerDeliverySelectionResult":{"properties":{"audience":{"const":"buyer","type":"string"},"checkout_session":{"$ref":"#/components/schemas/CheckoutSession"},"delivery_selection":{"$ref":"#/components/schemas/BuyerDeliverySelection"},"inventory_reservation":{"$ref":"#/components/schemas/DeliveryInventoryReservationSummary"},"order":{"$ref":"#/components/schemas/Order"}},"required":["audience","checkout_session","delivery_selection","order"],"type":"object"},"BuyerEffectiveDeliverySelectionResource":{"properties":{"audience":{"const":"buyer","type":"string"},"delivery_selection":{"anyOf":[{"$ref":"#/components/schemas/BuyerDeliverySelection"},{"type":"null"}]},"mutable":{"type":"boolean"},"source":{"enum":["none","provisional","committed"],"type":"string","x-enum-descriptions":["None.","Provisional.","Committed."],"x-flint-enum":"closed"}},"required":["audience","mutable","source"],"type":"object"},"BuyerInstructionsConfig":{"description":"Controls buyer instructions for a delivery option. Omit it from a method configuration to disable instruction collection.","properties":{"enabled":{"description":"Whether checkout collects buyer instructions.","type":"boolean"},"label":{"description":"Checkout field label, without leading or trailing whitespace. Clients use a delivery-type default when omitted.","maxLength":255,"type":"string"},"placeholder":{"description":"Checkout field placeholder, without leading or trailing whitespace. Clients use a delivery-type default when omitted.","maxLength":500,"type":"string"},"required":{"description":"Whether the buyer must enter instructions before selecting the option. Requires enabled=true.","type":"boolean"}},"required":["enabled","required"],"type":"object"},"BuyerInvoice":{"properties":{"cc_emails":{"items":{"type":"string"},"type":"array"},"closed_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"collection_block_status":{"enum":["none","inventory_blocked","resolved"],"readOnly":true,"type":"string","x-enum-descriptions":["None.","Inventory blocked.","Resolved."],"x-flint-enum":"open"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"credit_money":{"$ref":"#/components/schemas/Money","readOnly":true},"currently_due_money":{"$ref":"#/components/schemas/Money","readOnly":true},"customer":{"anyOf":[{"$ref":"#/components/schemas/ExpandedCustomerSummary"},{"type":"null"}],"readOnly":true},"customer_id":{"readOnly":true,"type":"string"},"due_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"footer":{"type":"string"},"invoice_id":{"readOnly":true,"type":"string"},"invoice_number":{"description":"Sequential document number assigned when the invoice is issued. Numbering is per merchant, with test and live mode numbered independently.","readOnly":true,"type":"string"},"is_overdue":{"readOnly":true,"type":"boolean"},"issued_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"late_fees":{"items":{"$ref":"#/components/schemas/BuyerInvoiceLateFee"},"readOnly":true,"type":"array"},"memo":{"type":"string"},"merchant_id":{"readOnly":true,"type":"string"},"order":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrderSummary"},{"type":"null"}],"readOnly":true},"order_id":{"readOnly":true,"type":"string"},"outstanding_money":{"$ref":"#/components/schemas/Money","readOnly":true},"paid_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"paid_money":{"$ref":"#/components/schemas/Money","readOnly":true},"payment_terms_snapshot":{"$ref":"#/components/schemas/InvoicePaymentTermsSnapshot","readOnly":true},"po_number":{"readOnly":true,"type":"string"},"recipient_email":{"type":"string"},"reference":{"type":"string"},"refund_status":{"enum":["none","partially_refunded","refunded"],"readOnly":true,"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"refunded_money":{"$ref":"#/components/schemas/Money","readOnly":true},"remit_to_address":{"$ref":"#/components/schemas/Address","readOnly":true},"schedule_entries":{"items":{"$ref":"#/components/schemas/InvoiceScheduleEntry"},"readOnly":true,"type":"array"},"scheduled_send_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"service_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"snapshot":{"$ref":"#/components/schemas/InvoiceSnapshot","readOnly":true},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"readOnly":true,"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"timezone":{"readOnly":true,"type":"string"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"version":{"description":"Current invoice version. Send this as expected_version when updating the draft.","format":"int64","minimum":1,"readOnly":true,"type":"integer"},"viewed_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"voided_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"}},"required":["collection_block_status","credit_money","currently_due_money","invoice_id","is_overdue","late_fees","merchant_id","order_id","outstanding_money","paid_money","refund_status","refunded_money","status","version"],"type":"object"},"BuyerInvoiceLateFee":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"assessed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"base_outstanding_money":{"$ref":"#/components/schemas/Money"},"invoice_late_fee_id":{"type":"string"},"invoice_schedule_entry_id":{"type":"string"},"late_fee_policy":{"$ref":"#/components/schemas/InvoiceLateFeePolicy"},"outstanding_money":{"$ref":"#/components/schemas/Money"},"paid_money":{"$ref":"#/components/schemas/Money"},"waived_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"waived_money":{"$ref":"#/components/schemas/Money"},"written_off_money":{"$ref":"#/components/schemas/Money"}},"required":["amount_money","assessed_at","base_outstanding_money","invoice_late_fee_id","outstanding_money","paid_money","waived_money","written_off_money"],"type":"object"},"BuyerInvoiceListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/BuyerInvoice"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"BuyerInvoiceResponse":{"properties":{"data":{"$ref":"#/components/schemas/BuyerInvoice"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CLIContextsRequest":{"not":{"required":["client_secret"]},"properties":{"client_id":{"enum":["flint-cli"],"type":"string","x-enum-descriptions":["Flint-cli."],"x-flint-enum":"closed"},"refresh_token":{"type":"string"}},"required":["client_id","refresh_token"],"type":"object"},"CLIContextsResponse":{"properties":{"contexts":{"items":{"$ref":"#/components/schemas/ContextSummary"},"maxItems":100,"type":"array"},"oauth_session_id":{"type":"string"}},"required":["contexts","oauth_session_id"],"type":"object"},"CLIDeviceRequest":{"additionalProperties":false,"not":{"required":["client_secret"]},"properties":{"client_id":{"enum":["flint-cli"],"type":"string","x-enum-descriptions":["Flint-cli."],"x-flint-enum":"closed"},"device_name":{"description":"Optional compatibility field for the computer name sent by released Flint CLI versions. Accepted and ignored.","type":"string"},"environment":{"enum":["sandbox","live"],"type":"string","x-enum-descriptions":["Sandbox.","Live."],"x-flint-enum":"closed"},"merchant_id":{"type":"string"},"platform":{"description":"Optional compatibility field for the operating system sent by released Flint CLI versions. Accepted and ignored.","type":"string"},"sandbox_id":{"type":"string"},"scope":{"description":"Required space-separated public API scope names. Only requested scopes approved in the browser are granted. Normal login sends x-flint-cli-bootstrap-scopes; explicit requests may use x-flint-cli-allowed-scopes. Unsupported scopes return invalid_scope.","minLength":1,"type":"string"},"session_mode":{"enum":["contexts"],"type":"string","x-enum-descriptions":["Contexts."],"x-flint-enum":"closed"}},"required":["client_id","scope"],"type":"object"},"CLIDeviceResponse":{"properties":{"device_code":{"maxLength":4096,"minLength":1,"type":"string"},"expires_in":{"maximum":1800,"minimum":1,"type":"integer"},"interval":{"maximum":60,"minimum":1,"type":"integer"},"user_code":{"maxLength":32,"minLength":4,"pattern":"^[!-~]+$","type":"string"},"verification_uri":{"type":"string"},"verification_uri_complete":{"type":"string"}},"required":["device_code","expires_in","interval","user_code","verification_uri","verification_uri_complete"],"type":"object"},"CLIReauthorizeRequest":{"additionalProperties":false,"dependentRequired":{"scope_mode":["context_id"]},"not":{"required":["client_secret"]},"properties":{"client_id":{"enum":["flint-cli"],"type":"string","x-enum-descriptions":["Flint-cli."],"x-flint-enum":"closed"},"context_id":{"minLength":1,"type":"string"},"device_name":{"description":"Optional compatibility field for the computer name sent by released Flint CLI versions. Accepted and ignored.","type":"string"},"environment":{"enum":["sandbox","live"],"type":"string","x-enum-descriptions":["Sandbox.","Live."],"x-flint-enum":"closed"},"merchant_id":{"type":"string"},"platform":{"description":"Optional compatibility field for the operating system sent by released Flint CLI versions. Accepted and ignored.","type":"string"},"refresh_token":{"type":"string"},"sandbox_id":{"type":"string"},"scope":{"description":"Required space-separated public API scope names. Only requested scopes approved in the browser are granted. Normal login sends x-flint-cli-bootstrap-scopes; explicit requests may use x-flint-cli-allowed-scopes. Unsupported scopes return invalid_scope.","minLength":1,"type":"string"},"scope_mode":{"enum":["additive"],"type":"string","x-enum-descriptions":["Additive."],"x-flint-enum":"closed"},"session_mode":{"enum":["contexts"],"type":"string","x-enum-descriptions":["Contexts."],"x-flint-enum":"closed"}},"required":["client_id","refresh_token","scope","session_mode"],"type":"object"},"CLIRevokeRequest":{"not":{"required":["client_secret"]},"properties":{"client_id":{"enum":["flint-cli"],"type":"string","x-enum-descriptions":["Flint-cli."],"x-flint-enum":"closed"},"token":{"type":"string"},"token_type_hint":{"enum":["refresh_token","access_token"],"type":"string","x-enum-descriptions":["Refresh token.","Access token."],"x-flint-enum":"closed"}},"required":["client_id","token"],"type":"object"},"CLITokenRequest":{"not":{"required":["client_secret"]},"oneOf":[{"properties":{"grant_type":{"const":"urn:ietf:params:oauth:grant-type:device_code"}},"required":["device_code"]},{"properties":{"grant_type":{"const":"refresh_token"}},"required":["refresh_token"]}],"properties":{"client_id":{"enum":["flint-cli"],"type":"string","x-enum-descriptions":["Flint-cli."],"x-flint-enum":"closed"},"context_id":{"type":"string"},"device_code":{"type":"string"},"grant_type":{"enum":["urn:ietf:params:oauth:grant-type:device_code","refresh_token"],"type":"string","x-enum-descriptions":["Urn:ietf:params:oauth:grant-type:device code.","Refresh token."],"x-flint-enum":"closed"},"refresh_token":{"type":"string"},"scope":{"type":"string"}},"required":["client_id","grant_type"],"type":"object"},"CLITokenResponse":{"dependentRequired":{"context_id":["oauth_session_id"],"oauth_session_id":["context_id"]},"properties":{"access_token":{"minLength":1,"type":"string"},"context_id":{"minLength":1,"type":"string"},"expires_in":{"maximum":86400,"minimum":1,"type":"integer"},"oauth_session_id":{"minLength":1,"type":"string"},"refresh_token":{"minLength":1,"type":"string"},"scope":{"minLength":1,"type":"string"},"token_type":{"enum":["Bearer"],"type":"string","x-enum-descriptions":["Bearer."],"x-flint-enum":"closed"}},"required":["access_token","expires_in","refresh_token","scope","token_type"],"type":"object"},"CallerSuppliedDeliveryMethodResultRequest":{"properties":{"delivery_choice_group_id":{"type":"string"},"delivery_method_revision_id":{"type":"string"},"outcome":{"$ref":"#/components/schemas/CallerSuppliedDeliveryOutcomeRequest"}},"required":["delivery_choice_group_id","delivery_method_revision_id","outcome"],"type":"object"},"CallerSuppliedDeliveryOutcomeRequest":{"discriminator":{"propertyName":"type"},"oneOf":[{"properties":{"type":{"enum":["available"],"type":"string","x-enum-descriptions":["Available."],"x-flint-enum":"closed"}},"required":["type","amount_money","expires_at","selection_guarantee_expires_at"]},{"properties":{"type":{"enum":["unavailable"],"type":"string","x-enum-descriptions":["Unavailable."],"x-flint-enum":"closed"}},"required":["type","unavailable_reason"]},{"properties":{"type":{"enum":["cannot_calculate"],"type":"string","x-enum-descriptions":["Cannot calculate."],"x-flint-enum":"closed"}},"required":["type","failure_category","retryable"]}],"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"failure_category":{"description":"Why Flint could not calculate the method and the action that can make calculation succeed.\n- `dependency_failure`: Retry after the dependent service recovers.\n- `timeout`: Retry after the timed-out dependency recovers.\n- `malformed_response`: Fix the callback response so it matches the documented response schema, then retry.\n- `callback_transport_failure`: Restore callback DNS, TLS, network connectivity, and response timing, then retry.\n- `callback_result_invalid`: Fix the callback result fields or values identified by the callback logs, then retry.\n- `pricing_failure`: Fix the method pricing configuration or matching rate, then retry.\n- `schedule_failure`: Fix the method schedule, timezone, or requested window, then retry.\n- `geography_failure`: Fix the destination, origin, or geographic configuration, then retry.\n- `routing_failure`: Fix inventory routing or origin assignment, then retry.\n- `address_verification_failed`: Correct the address fields rejected by verification, then retry.\n- `address_could_not_be_verified`: Confirm or correct the address, or retry when address verification is available.","enum":["dependency_failure","timeout","malformed_response","callback_transport_failure","callback_result_invalid","pricing_failure","schedule_failure","geography_failure","routing_failure","address_verification_failed","address_could_not_be_verified"],"type":"string","x-enum-descriptions":["Dependency failure.","Timeout.","Malformed response.","Callback transport failure.","Callback result invalid.","Pricing failure.","Schedule failure.","Geography failure.","Routing failure.","Address verification failed.","Address could not be verified."],"x-flint-enum":"closed","x-flint-enum-descriptions":{"address_could_not_be_verified":"Confirm or correct the address, or retry when address verification is available.","address_verification_failed":"Correct the address fields rejected by verification, then retry.","callback_result_invalid":"Fix the callback result fields or values identified by the callback logs, then retry.","callback_transport_failure":"Restore callback DNS, TLS, network connectivity, and response timing, then retry.","dependency_failure":"Retry after the dependent service recovers.","geography_failure":"Fix the destination, origin, or geographic configuration, then retry.","malformed_response":"Fix the callback response so it matches the documented response schema, then retry.","pricing_failure":"Fix the method pricing configuration or matching rate, then retry.","routing_failure":"Fix inventory routing or origin assignment, then retry.","schedule_failure":"Fix the method schedule, timezone, or requested window, then retry.","timeout":"Retry after the timed-out dependency recovers."}},"merchant_reference":{"maxLength":500,"type":"string"},"offered_windows":{"items":{"$ref":"#/components/schemas/DeliveryWindowRequest"},"type":"array"},"retryable":{"type":"boolean"},"selection_guarantee_expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"service_level":{"type":"string"},"type":{"enum":["available","unavailable","cannot_calculate"],"type":"string","x-enum-descriptions":["Available.","Unavailable.","Cannot calculate."],"x-flint-enum":"closed"},"unavailable_reason":{"description":"Why the method is unavailable and the action that can make it eligible.\n- `destination_not_served`: Use a destination covered by this method or choose another method.\n- `pickup_unavailable`: Choose an available pickup method or location.\n- `no_window_available`: Choose another offered window or a method with availability for the requested time.\n- `eligibility_no_match`: Inspect eligibility_mismatches, then change the relevant buyer facts or method eligibility rule.\n- `pricing_unavailable`: Add or activate a matching rate, or provide the required caller-supplied price.\n- `inventory_unavailable`: Choose an origin or method backed by available inventory.","enum":["destination_not_served","pickup_unavailable","no_window_available","eligibility_no_match","pricing_unavailable","inventory_unavailable"],"type":"string","x-enum-descriptions":["Destination not served.","Pickup unavailable.","No window available.","Eligibility no match.","Pricing unavailable.","Inventory unavailable."],"x-flint-enum":"closed","x-flint-enum-descriptions":{"destination_not_served":"Use a destination covered by this method or choose another method.","eligibility_no_match":"Inspect eligibility_mismatches, then change the relevant buyer facts or method eligibility rule.","inventory_unavailable":"Choose an origin or method backed by available inventory.","no_window_available":"Choose another offered window or a method with availability for the requested time.","pickup_unavailable":"Choose an available pickup method or location.","pricing_unavailable":"Add or activate a matching rate, or provide the required caller-supplied price."}},"window_end_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"window_start_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["type"],"type":"object"},"CancelOrderPaymentAttemptRequest":{"properties":{"cancellation_reason":{"description":"Optional merchant-supplied cancellation reason. Use metadata for unrelated caller-owned context.","enum":["requested_by_customer","duplicate","fraudulent","abandoned"],"type":"string","x-enum-descriptions":["Requested by customer.","Duplicate.","Fraudulent.","Abandoned."],"x-flint-enum":"closed"}},"type":"object"},"CancelOrderPaymentAttemptResponse":{"properties":{"data":{"$ref":"#/components/schemas/CancelOrderPaymentAttemptResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CancelOrderPaymentAttemptResult":{"properties":{"order":{"$ref":"#/components/schemas/Order"},"payment_attempt":{"$ref":"#/components/schemas/OrderPaymentAttempt"}},"required":["order"],"type":"object"},"CancelOrderPaymentRequest":{"properties":{"cancellation_reason":{"description":"Optional merchant-supplied cancellation reason. Use metadata for unrelated caller-owned context.","enum":["requested_by_customer","duplicate","fraudulent","abandoned"],"type":"string","x-enum-descriptions":["Requested by customer.","Duplicate.","Fraudulent.","Abandoned."],"x-flint-enum":"closed"},"payment_attempt_id":{"description":"Owning Flint payment attempt ID. Required while the payment leg belongs to an active attempt.","type":"string"}},"type":"object"},"CancelPaymentIntentRequest":{"properties":{"cancellation_reason":{"description":"Optional merchant-supplied cancellation reason. Use metadata for unrelated caller-owned context.","enum":["requested_by_customer","duplicate","fraudulent","abandoned"],"type":"string","x-enum-descriptions":["Requested by customer.","Duplicate.","Fraudulent.","Abandoned."],"x-flint-enum":"closed"}},"type":"object"},"CancelPayoutRequest":{"properties":{},"type":"object"},"CancelReturnDispositionRequest":{"additionalProperties":false,"properties":{"expected_version":{"format":"int64","minimum":1,"type":"integer"},"reason":{"enum":["created_in_error","changed_disposition","duplicate","other"],"type":"string","x-enum-descriptions":["Created in error.","Changed disposition.","Duplicate.","Other."],"x-flint-enum":"closed"},"reason_message":{"type":"string"}},"required":["reason"],"type":"object"},"CancelReturnDispositionResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnDisposition"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CancelReturnLineItemRequest":{"additionalProperties":false,"properties":{"expected_version":{"format":"int64","minimum":1,"type":"integer"},"handback_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"reason":{"enum":["buyer_request","merchant_request","expired","created_in_error","other"],"type":"string","x-enum-descriptions":["Buyer request.","Merchant request.","Expired.","Created in error.","Other."],"x-flint-enum":"closed"},"reason_message":{"type":"string"}},"required":["handback_quantity","quantity","reason"],"type":"object"},"CancelReturnLineItemResponse":{"properties":{"data":{"$ref":"#/components/schemas/Return"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CancelReturnRequest":{"additionalProperties":false,"properties":{"expected_version":{"format":"int64","minimum":1,"type":"integer"},"reason":{"enum":["buyer_request","merchant_request","duplicate","expired","created_in_error","other"],"type":"string","x-enum-descriptions":["Buyer request.","Merchant request.","Duplicate.","Expired.","Created in error.","Other."],"x-flint-enum":"closed"},"reason_message":{"type":"string"}},"required":["reason"],"type":"object"},"CancelReturnResolutionRequest":{"additionalProperties":false,"properties":{"expected_version":{"format":"int64","minimum":1,"type":"integer"},"reason":{"enum":["buyer_request","merchant_request","duplicate","expired","created_in_error","other"],"type":"string","x-enum-descriptions":["Buyer request.","Merchant request.","Duplicate.","Expired.","Created in error.","Other."],"x-flint-enum":"closed"},"reason_message":{"type":"string"}},"required":["reason"],"type":"object"},"CancelReturnResolutionResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnResolution"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CancelReturnResponse":{"properties":{"data":{"$ref":"#/components/schemas/Return"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CancelSubscriptionRequest":{"properties":{"cancel_immediately":{"type":"boolean"}},"type":"object"},"CancelSubscriptionResponse":{"properties":{"data":{"$ref":"#/components/schemas/CancelSubscriptionResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CancelSubscriptionResult":{"properties":{"awaiting_billing_schedule":{"readOnly":true,"type":"boolean"},"billing_anchor_day":{"format":"int32","type":"integer"},"billing_interval":{"description":"How often the subscription bills, frozen when the subscription was created. Read with billing_interval_count: monthly with a count of 3 bills quarterly. Omitted for subscriptions created before Flint recorded this interval.","enum":["daily","weekly","monthly","yearly"],"readOnly":true,"type":"string","x-enum-descriptions":["Daily.","Weekly.","Monthly.","Yearly."],"x-flint-enum":"closed"},"billing_interval_count":{"description":"Number of billing_interval units between charges, frozen when the subscription was created. Omitted for subscriptions created before Flint recorded this interval.","format":"int32","readOnly":true,"type":"integer"},"billing_schedule_owner":{"enum":["flint","external"],"readOnly":true,"type":"string","x-enum-descriptions":["Flint.","External."],"x-flint-enum":"closed"},"billing_schedule_waiting_started_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"cancel_at_period_end":{"type":"boolean"},"canceled_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"contract_end_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"contract_info":{"$ref":"#/components/schemas/ContractInfo"},"contract_start_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"current_period_end":{"readOnly":true,"type":"string"},"current_period_start":{"readOnly":true,"type":"string"},"customer":{"anyOf":[{"$ref":"#/components/schemas/ExpandedCustomerSummary"},{"type":"null"}],"readOnly":true},"customer_id":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"line_items":{"items":{"$ref":"#/components/schemas/SubscriptionLineItem"},"readOnly":true,"type":"array"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"next_billing_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"next_retry_at":{"description":"Recorded automatic payment retry time. Null when no retry time is available.","format":"date-time","readOnly":true,"type":["string","null"]},"paused_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"payment_method":{"anyOf":[{"$ref":"#/components/schemas/ExpandedPaymentMethodSummary"},{"type":"null"}],"readOnly":true},"payment_method_id":{"type":"string"},"plan_id":{"type":"string"},"recurring_amount_money":{"$ref":"#/components/schemas/Money","description":"What one billing period charges before tax and discounts, frozen when the subscription was created. Plan price changes after that do not change it. Omitted for subscriptions created before Flint recorded this amount.","readOnly":true},"service_location":{"$ref":"#/components/schemas/SubscriptionServiceLocation"},"starts_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"status":{"enum":["trialing","active","paused","past_due","canceled","incomplete"],"readOnly":true,"type":"string","x-enum-descriptions":["Trialing.","Active.","Paused.","Past due.","Canceled.","Incomplete."],"x-flint-enum":"open"},"subscription_id":{"readOnly":true,"type":"string"},"subscription_plan":{"anyOf":[{"$ref":"#/components/schemas/ExpandedSubscriptionPlanSummary"},{"type":"null"}],"readOnly":true},"trial_end":{"readOnly":true,"type":"string"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"}},"required":["cancel_at_period_end","customer_id","payment_method_id","plan_id","status","subscription_id"],"type":"object"},"Capability":{"description":"Merchant capability readiness for a payment or money movement capability.","properties":{"blocked_reasons":{"description":"Reasons this capability is blocked, pending, or not available.","items":{"$ref":"#/components/schemas/MoneyMovementBlockedReason"},"type":"array"},"capability":{"description":"Flint-owned capability name. Payment capabilities describe transaction acceptance readiness; money movement capabilities describe payout and balance movement readiness.","enum":["accept_card_payments","save_payment_methods","accept_affirm_payments","receive_payouts","create_standard_payouts","manage_payout_destinations","manage_payout_settings"],"type":"string","x-enum-descriptions":["Accept card payments.","Save payment methods.","Accept affirm payments.","Receive payouts.","Create standard payouts.","Manage payout destinations.","Manage payout settings."],"x-flint-enum":"closed"},"domain":{"description":"Capability domain. API keys scoped to one domain only receive that domain when listing capabilities without a domain filter.","enum":["money_movement","payments"],"type":"string","x-enum-descriptions":["Money movement.","Payments."],"x-flint-enum":"closed"},"next_actions":{"description":"Actions that can remediate or refresh this capability when Flint can suggest one.","items":{"$ref":"#/components/schemas/NextAction"},"type":"array"},"observed_at":{"description":"RFC3339 timestamp for the source state used to evaluate this capability.","format":"date-time","type":"string"},"requirements":{"$ref":"#/components/schemas/CapabilityRequirements","description":"Merchant requirements that affect this capability."},"status":{"description":"Current readiness status for this capability.","enum":["ready","blocked","pending","not_available"],"type":"string","x-enum-descriptions":["Ready.","Blocked.","Pending.","Not available."],"x-flint-enum":"open"}},"required":["capability","domain","requirements","status"],"type":"object"},"CapabilityListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Capability"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CapabilityRequirements":{"properties":{"current_deadline_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"currently_due_fields":{"items":{"type":"string"},"type":"array"},"disabled_reason":{"description":"Normalized reason the related account requirements currently disable or block the capability.","enum":["account_attention_required","account_paused","account_rejected","account_requirements_due","account_under_review","requirements_past_due","requirements_pending_verification",null],"type":["string","null"],"x-enum-descriptions":["Account attention required.","Account paused.","Account rejected.","Account requirements due.","Account under review.","Requirements past due.","Requirements pending verification.","Null."],"x-flint-enum":"closed"},"eventually_due_fields":{"items":{"type":"string"},"type":"array"},"past_due_fields":{"items":{"type":"string"},"type":"array"},"pending_verification_fields":{"items":{"type":"string"},"type":"array"}},"type":"object"},"CaptureOrderPaymentRequest":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"payment_attempt_id":{"description":"Owning Flint payment attempt ID. Required while the authorization belongs to an active attempt.","type":"string"}},"type":"object"},"CapturePaymentIntentRequest":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"}},"type":"object"},"CardDetails":{"properties":{"brand":{"enum":["visa","mastercard","amex","discover","diners","jcb","unionpay"],"type":"string","x-enum-descriptions":["Visa.","Mastercard.","Amex.","Discover.","Diners.","Jcb.","Unionpay."],"x-flint-enum":"closed"},"exp_month":{"format":"int32","type":"integer"},"exp_year":{"format":"int32","type":"integer"},"last4":{"type":"string"},"wallet":{"type":"string"}},"required":["brand","exp_month","exp_year","last4"],"type":"object"},"CatalogSettings":{"additionalProperties":false,"properties":{"default_delivery_profile_id":{"description":"Active delivery profile assigned to new physical catalog items.","type":"string"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"version":{"description":"Version used to fence catalog setting changes.","format":"uint64","minimum":1,"type":"integer"}},"required":["default_delivery_profile_id","version"],"type":"object"},"Category":{"properties":{"assigned_bundle_count":{"format":"int64","type":"integer"},"assigned_product_count":{"format":"int64","type":"integer"},"category_id":{"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"description":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"handle":{"type":"string"},"merchant_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"status":{"enum":["active","archived","deleted"],"type":"string","x-enum-descriptions":["Active.","Archived.","Deleted."],"x-flint-enum":"open"},"targeting_reference_count":{"format":"int64","type":"integer"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["assigned_bundle_count","assigned_product_count","category_id","created_at","handle","name","status","targeting_reference_count","updated_at"],"type":"object"},"CategoryListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Category"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CategoryReference":{"properties":{"category_id":{"type":"string"},"handle":{"type":"string"},"name":{"type":"string"}},"required":["handle","name"],"type":"object"},"CategoryResponse":{"properties":{"data":{"$ref":"#/components/schemas/Category"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ChangeSubscriptionPaymentMethodRequest":{"properties":{"payment_method_id":{"type":"string"}},"required":["payment_method_id"],"type":"object"},"CheckoutAccess":{"properties":{"checkout_auth_token":{"type":"string"},"hosted_url":{"type":"string"}},"required":["checkout_auth_token"],"type":"object"},"CheckoutCustomTextConfig":{"properties":{"order_summary_message":{"type":"string"},"shipping_address_label":{"type":"string"}},"type":"object"},"CheckoutCustomTextWriteConfig":{"properties":{"order_summary_message":{"type":"string"},"shipping_address_label":{"type":"string"}},"type":"object"},"CheckoutCustomerConfig":{"properties":{"customer_id":{"type":"string"},"enable_address_autocomplete":{"type":"boolean"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"prefilled_customer_info":{"$ref":"#/components/schemas/PrefilledCustomerInfo"},"require_billing_address":{"type":"boolean"},"require_email":{"type":"boolean"},"require_phone":{"type":"boolean"}},"type":"object"},"CheckoutDeliveryPinnedDependency":{"properties":{"delivery_dependency_id":{"type":"string"},"delivery_dependency_role":{"enum":["assigned_method","eligibility","method_origin","pickup_collection","pricing_callback","evaluation","origin"],"type":"string","x-enum-descriptions":["Assigned method.","Eligibility.","Method origin.","Pickup collection.","Pricing callback.","Evaluation.","Origin."],"x-flint-enum":"closed"},"delivery_dependency_type":{"enum":["delivery_method","delivery_zone","delivery_location_set_revision","delivery_rate_callback","location_geography","evaluation_schema","other"],"type":"string","x-enum-descriptions":["Delivery method.","Delivery zone.","Delivery location set revision.","Delivery rate callback.","Location geography.","Evaluation schema.","Other."],"x-flint-enum":"closed"},"geography_revision":{"format":"int64","type":"integer"},"revision_id":{"type":"string"}},"required":["delivery_dependency_id","delivery_dependency_role","delivery_dependency_type"],"type":"object"},"CheckoutDeliveryQuoteResponse":{"properties":{"data":{"discriminator":{"mapping":{"buyer":"#/components/schemas/BuyerDeliveryQuote","merchant":"#/components/schemas/DeliveryQuote"},"propertyName":"audience"},"oneOf":[{"$ref":"#/components/schemas/DeliveryQuote"},{"$ref":"#/components/schemas/BuyerDeliveryQuote"}]},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CheckoutDeliverySelectionResultResponse":{"properties":{"data":{"discriminator":{"mapping":{"buyer":"#/components/schemas/BuyerDeliverySelectionResult","merchant":"#/components/schemas/DeliverySelectionResult"},"propertyName":"audience"},"oneOf":[{"$ref":"#/components/schemas/DeliverySelectionResult"},{"$ref":"#/components/schemas/BuyerDeliverySelectionResult"}]},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CheckoutDerivedDeliveryResource":{"properties":{"buyer_reasons":{"items":{"type":"string"},"type":"array"},"choice_groups":{"items":{"$ref":"#/components/schemas/BuyerDeliveryQuoteChoiceGroupResource"},"type":"array"},"delivery_quote_id":{"type":"string"},"evaluation_status":{"enum":["complete","incomplete","degraded","requires_explicit_quote"],"type":"string","x-enum-descriptions":["Complete.","Incomplete.","Degraded.","Requires explicit quote."],"x-flint-enum":"open"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"input_requirements":{"items":{"$ref":"#/components/schemas/BuyerDeliveryInputRequirementResource"},"type":"array"}},"required":["buyer_reasons","choice_groups","evaluation_status","input_requirements"],"type":"object"},"CheckoutDerivedMerchantDeliveryResource":{"properties":{"choice_groups":{"items":{"$ref":"#/components/schemas/DeliveryQuoteChoiceGroupResource"},"type":"array"},"delivery_quote_id":{"type":"string"},"evaluation_status":{"enum":["complete","incomplete","degraded","requires_explicit_quote"],"type":"string","x-enum-descriptions":["Complete.","Incomplete.","Degraded.","Requires explicit quote."],"x-flint-enum":"open"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"input_requirements":{"items":{"$ref":"#/components/schemas/DeliveryInputRequirement"},"type":"array"},"merchant_diagnostics":{"items":{"$ref":"#/components/schemas/DeliveryMerchantDiagnostic"},"type":"array"}},"required":["choice_groups","evaluation_status","input_requirements","merchant_diagnostics"],"type":"object"},"CheckoutEffectiveDeliverySelectionResponse":{"properties":{"data":{"discriminator":{"mapping":{"buyer":"#/components/schemas/BuyerEffectiveDeliverySelectionResource","merchant":"#/components/schemas/EffectiveDeliverySelectionResource"},"propertyName":"audience"},"oneOf":[{"$ref":"#/components/schemas/EffectiveDeliverySelectionResource"},{"$ref":"#/components/schemas/BuyerEffectiveDeliverySelectionResource"}]},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CheckoutExpirationConfig":{"properties":{"expiration_url":{"description":"Optional URL to send buyers to after the checkout session expires.","type":"string"},"expires_in_seconds":{"description":"Duration in seconds before the checkout session expires after creation.","format":"int64","type":"integer"}},"type":"object"},"CheckoutLegalConfig":{"properties":{"contract_url":{"type":"string"},"refund_policy_url":{"type":"string"},"require_terms_of_service":{"type":"boolean"},"shipping_policy_url":{"type":"string"},"terms_of_service_url":{"type":"string"}},"type":"object"},"CheckoutPaymentConfig":{"properties":{"enabled_payment_options":{"items":{"type":"string"},"type":"array"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"payment_note":{"type":"string"}},"type":"object"},"CheckoutProblemResource":{"properties":{"blocks_completion":{"type":"boolean"},"code":{"enum":["delivery_selection_stale","delivery_selection_invalid"],"type":"string","x-enum-descriptions":["Delivery selection stale.","Delivery selection invalid."],"x-flint-enum":"closed"},"remediation":{"$ref":"#/components/schemas/ErrorRemediation"},"severity":{"enum":["error"],"type":"string","x-enum-descriptions":["Error."],"x-flint-enum":"closed"}},"required":["blocks_completion","code","severity"],"type":"object"},"CheckoutPromotionConfig":{"properties":{"automatic_enabled":{"type":"boolean"},"codes_enabled":{"description":"Object-level override for hosted checkout promotion code entry and application. Omit to inherit the merchant checkout default. True shows code entry when policy allows it; false hides it for this checkout.","type":["boolean","null"]}},"type":"object"},"CheckoutQuickPayItemInput":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"name":{"type":"string"},"tax":{"$ref":"#/components/schemas/OrderLineItemTax"}},"required":["amount_money","name"],"type":"object"},"CheckoutRedirectsConfig":{"properties":{"cancel_redirect_url":{"type":"string"},"on_load_redirect_url":{"type":"string"},"success_redirect_url":{"type":"string"}},"type":"object"},"CheckoutSession":{"properties":{"active_payment_attempt":{"$ref":"#/components/schemas/OrderPaymentAttempt","readOnly":true},"checkout_session_id":{"readOnly":true,"type":"string"},"closed_reason":{"description":"Internal reason supplied when the checkout session was closed. This is not shown to the buyer.","readOnly":true,"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"custom_text":{"$ref":"#/components/schemas/CheckoutCustomTextConfig"},"customer":{"anyOf":[{"$ref":"#/components/schemas/ExpandedCustomerSummary"},{"type":"null"}],"readOnly":true},"customer_collection":{"$ref":"#/components/schemas/CheckoutCustomerConfig"},"delivery_method_ids":{"description":"Immutable delivery method assignment captured when the checkout was created.","items":{"type":"string"},"type":"array"},"delivery_pinned_dependencies":{"description":"Merchant-only immutable configuration lineage used to evaluate delivery quotes.","items":{"$ref":"#/components/schemas/CheckoutDeliveryPinnedDependency"},"readOnly":true,"type":"array"},"delivery_selection_required":{"description":"Whether the order has at least one remaining quote-resolved fulfillment choice that must be selected before payment.","readOnly":true,"type":"boolean"},"expiration":{"$ref":"#/components/schemas/CheckoutExpirationConfig"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"fulfillment":{"description":"Current fulfillment choices for Flint-owned pricing. Checkout credentials receive the fields available to buyers; merchant credentials also receive configuration lineage and diagnostics. External pricing reports requires_explicit_quote; reading this field does not request a delivery quote.","oneOf":[{"$ref":"#/components/schemas/CheckoutDerivedMerchantDeliveryResource"},{"$ref":"#/components/schemas/CheckoutDerivedDeliveryResource"}],"readOnly":true},"invoice":{"anyOf":[{"$ref":"#/components/schemas/ExpandedInvoiceSummary"},{"type":"null"}],"readOnly":true},"invoice_id":{"readOnly":true,"type":"string"},"legal":{"$ref":"#/components/schemas/CheckoutLegalConfig"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrderSummary"},{"type":"null"}],"readOnly":true},"order_id":{"type":"string"},"origin":{"enum":["virtual_terminal","payment_link","checkout","api","subscription"],"readOnly":true,"type":"string","x-enum-descriptions":["Virtual terminal.","Payment link.","Checkout.","Api.","Subscription."],"x-flint-enum":"closed"},"payment_collection":{"$ref":"#/components/schemas/PaymentCollection","readOnly":true},"payment_intent_id":{"type":"string"},"payment_intent_ids":{"items":{"type":"string"},"readOnly":true,"type":"array"},"payment_intents":{"items":{"$ref":"#/components/schemas/ExpandedPaymentIntentSummary"},"readOnly":true,"type":"array"},"payment_link":{"anyOf":[{"$ref":"#/components/schemas/ExpandedPaymentLinkSummary"},{"type":"null"}],"readOnly":true},"payment_link_id":{"readOnly":true,"type":"string"},"payments":{"$ref":"#/components/schemas/CheckoutPaymentConfig"},"plan_id":{"readOnly":true,"type":"string"},"problems":{"description":"Named conditions that affect checkout completion. Follow each problem's remediation action instead of reconstructing delivery lifecycle rules in the client.","items":{"$ref":"#/components/schemas/CheckoutProblemResource"},"readOnly":true,"type":"array"},"promotion_config":{"$ref":"#/components/schemas/CheckoutPromotionConfig"},"recovery_expires_at":{"description":"RFC3339 deadline for the restricted payment-attempt recovery window.","format":"date-time","readOnly":true,"type":["string","null"]},"recovery_mode":{"description":"Whether this terminal session credential is temporarily restricted to recovering its owning payment attempt.","readOnly":true,"type":"boolean"},"recovery_payment_attempt_id":{"description":"Payment attempt that this checkout credential may recover while recovery_mode is true.","readOnly":true,"type":"string"},"redirects":{"$ref":"#/components/schemas/CheckoutRedirectsConfig"},"setup_collection":{"$ref":"#/components/schemas/PaymentCollection","readOnly":true},"status":{"enum":["open","paid","partially_paid","expired","closed","invalidated"],"readOnly":true,"type":"string","x-enum-descriptions":["Open.","Paid.","Partially paid.","Expired.","Closed.","Invalidated."],"x-flint-enum":"open"},"superseding_checkout_session_id":{"readOnly":true,"type":"string"},"surface":{"enum":["hosted","embedded"],"type":"string","x-enum-descriptions":["Hosted.","Embedded."],"x-flint-enum":"closed"},"tax":{"$ref":"#/components/schemas/CheckoutTaxConfig"},"terminal_reason":{"enum":["payment_succeeded","payment_partially_succeeded","expired","api","order_mutated","superseded","invoice_paid_elsewhere","invoice_voided","invoice_uncollectible","invoice_balance_changed"],"readOnly":true,"type":"string","x-enum-descriptions":["Payment succeeded.","Payment partially succeeded.","Expired.","Api.","Order mutated.","Superseded.","Invoice paid elsewhere.","Invoice voided.","Invoice uncollectible.","Invoice balance changed."],"x-flint-enum":"closed"},"theme":{"$ref":"#/components/schemas/ThemeConfig"},"tip":{"$ref":"#/components/schemas/CheckoutTipConfig"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"url":{"readOnly":true,"type":"string"}},"required":["checkout_session_id","delivery_method_ids","delivery_selection_required","problems","recovery_mode","status","surface"],"type":"object"},"CheckoutSessionLaunchResponse":{"properties":{"data":{"$ref":"#/components/schemas/CheckoutSessionLaunchResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CheckoutSessionLaunchResult":{"description":"Checkout-session access returned for hosted or embedded checkout creation.","properties":{"checkout_access":{"$ref":"#/components/schemas/CheckoutAccess"},"checkout_session":{"$ref":"#/components/schemas/CheckoutSession"},"hosted_checkout":{"$ref":"#/components/schemas/HostedCheckout"}},"required":["checkout_access","checkout_session"],"type":"object"},"CheckoutSessionLineItemModifierUpdate":{"properties":{"checkout_total_money":{"$ref":"#/components/schemas/Money"},"line_item":{"$ref":"#/components/schemas/OrderLineItem"},"payment_amount_money":{"$ref":"#/components/schemas/Money"},"version":{"format":"int64","type":"integer"}},"required":["checkout_total_money","line_item","payment_amount_money","version"],"type":"object"},"CheckoutSessionLineItemModifierUpdateResponse":{"properties":{"data":{"$ref":"#/components/schemas/CheckoutSessionLineItemModifierUpdate"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CheckoutSessionListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CheckoutSession"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CheckoutSessionResponse":{"properties":{"data":{"$ref":"#/components/schemas/CheckoutSession"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CheckoutSessionRevisionConflictDetail":{"properties":{"base_subtotal_money":{"$ref":"#/components/schemas/Money"},"checkout_total_money":{"$ref":"#/components/schemas/Money"},"code":{"type":"string"},"conflict_reason":{"type":"string"},"latest_revision":{"format":"int64","type":"integer"},"line_item_key":{"type":"string"},"message":{"type":"string"},"modifier_choices":{"items":{"$ref":"#/components/schemas/AvailableModifierGroup"},"type":"array"},"modifier_total_money":{"$ref":"#/components/schemas/Money"},"modifiers":{"items":{"$ref":"#/components/schemas/OrderLineItemModifier"},"type":"array"},"order_line_item_id":{"type":"string"},"param":{"type":"string"},"payment_amount_money":{"$ref":"#/components/schemas/Money"},"subtotal_money":{"$ref":"#/components/schemas/Money"},"tax_money":{"$ref":"#/components/schemas/Money"},"total_money":{"$ref":"#/components/schemas/SignedMoney"}},"required":["code","message"],"type":"object"},"CheckoutSettings":{"properties":{"default_delivery_method_ids":{"description":"Default immutable delivery method assignment used only when a checkout creation request omits delivery_method_ids. An explicit empty array overrides this default.","items":{"type":"string"},"type":"array"},"default_expires_in_seconds":{"description":"Default lifetime in seconds for generic checkout sessions. Invoice checkout sessions instead use the fixed deadline of the active invoice public-link generation.","format":"int64","type":"integer"},"enabled_payment_options":{"items":{"type":"string"},"type":"array"},"promotion_code_entry_enabled":{"description":"Merchant default for hosted checkout promotion code entry. Object-level promotion_config.codes_enabled can override it for a session or payment link.","type":"boolean"},"require_billing_address":{"type":"boolean"},"require_email":{"type":"boolean"},"require_phone":{"type":"boolean"}},"type":"object"},"CheckoutTaxConfig":{"properties":{"enabled":{"type":"boolean"}},"type":"object"},"CheckoutTipConfig":{"properties":{"default_smart_tip_money":{"$ref":"#/components/schemas/Money"},"default_tip_percentage":{"type":"number"},"enabled":{"type":"boolean"},"is_custom_tip_enabled":{"type":"boolean"},"is_smart_tips_enabled":{"type":"boolean"},"smart_tip_money_options":{"items":{"$ref":"#/components/schemas/Money"},"type":"array"},"tip_percentages":{"items":{"type":"number"},"type":"array"}},"type":"object"},"CloseCheckoutSessionRequest":{"properties":{"reason":{"description":"Internal reason for closing the checkout session. This is not shown to the buyer.","type":"string"}},"type":"object"},"CloseOrderRequest":{"properties":{"reason":{"description":"Internal reason for closing the order. This is not shown to the buyer.","type":"string"}},"type":"object"},"CollectInvoiceRequest":{"properties":{"invoice_schedule_entry_id":{"type":"string"},"payment_method_id":{"type":"string"}},"type":"object"},"CollectInvoiceResponse":{"properties":{"data":{"$ref":"#/components/schemas/CollectInvoiceResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CollectInvoiceResult":{"properties":{"idempotency_key":{"type":"string"},"invoice":{"$ref":"#/components/schemas/Invoice"},"invoice_payment_attempt":{"$ref":"#/components/schemas/InvoicePaymentAttempt"}},"required":["idempotency_key","invoice"],"type":"object"},"CommitInventoryReservationRequest":{"properties":{"expected_version":{"description":"Reservation version the caller last read.","format":"int64","type":"integer"},"lines":{"items":{"properties":{"inventory_reservation_line_id":{"description":"Line being transitioned.","type":"string"},"target_committed_quantity":{"description":"Cumulative quantity that should be committed on this line. Whole-number quantity; fractional quantities are not supported.","format":"int64","minimum":0,"type":"integer"}},"required":["inventory_reservation_line_id","target_committed_quantity"],"type":"object"},"type":"array"}},"required":["lines"],"type":"object"},"CompleteReturnRequest":{"additionalProperties":false,"properties":{"expected_version":{"format":"int64","minimum":1,"type":"integer"},"reason":{"enum":["manual_completion","exception_waived","other"],"type":"string","x-enum-descriptions":["Manual completion.","Exception waived.","Other."],"x-flint-enum":"closed"},"reason_message":{"type":"string"}},"type":"object"},"CompleteReturnResponse":{"properties":{"data":{"$ref":"#/components/schemas/Return"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ConfirmEmailChangeRequest":{"properties":{"current_email_code":{"type":"string"},"new_email_code":{"type":"string"}},"required":["new_email_code"],"type":"object"},"ConfirmPaymentIntentRequest":{"properties":{"confirmation_token":{"type":"string"},"payment_method_id":{"type":"string"},"payment_source_token":{"type":"string"}},"type":"object"},"ConfirmReturnResolutionRequest":{"additionalProperties":false,"properties":{"expected_version":{"format":"int64","minimum":1,"type":"integer"}},"type":"object"},"ConfirmReturnResolutionResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnResolution"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ConsumeInventoryReservationRequest":{"properties":{"expected_version":{"description":"Reservation version the caller last read.","format":"int64","type":"integer"},"lines":{"items":{"properties":{"inventory_reservation_line_id":{"description":"Line being transitioned.","type":"string"},"target_consumed_quantity":{"description":"Cumulative quantity that should be consumed on this line. Whole-number quantity; fractional quantities are not supported.","format":"int64","minimum":0,"type":"integer"}},"required":["inventory_reservation_line_id","target_consumed_quantity"],"type":"object"},"type":"array"},"provenance":{"$ref":"#/components/schemas/InventoryReservationProvenance","description":"When and where the physical handoff happened. Required on consume, rejected on commit and release."}},"required":["lines","provenance"],"type":"object"},"ContextSummary":{"allOf":[{"if":{"properties":{"environment":{"const":"sandbox"}}},"then":{"required":["sandbox_id"]}},{"if":{"properties":{"environment":{"const":"live"}}},"then":{"not":{"required":["sandbox_id"]}}}],"properties":{"environment":{"enum":["sandbox","live"],"type":"string","x-enum-descriptions":["Sandbox.","Live."],"x-flint-enum":"closed"},"id":{"type":"string"},"merchant_id":{"type":"string"},"name":{"type":"string"},"sandbox_id":{"type":"string"}},"required":["environment","id","merchant_id","name"],"type":"object"},"ContractInfo":{"properties":{"early_termination_fee_money":{"$ref":"#/components/schemas/Money"},"is_within_contract_term":{"type":"boolean"},"remaining_months":{"format":"int32","type":"integer"}},"required":["is_within_contract_term"],"type":"object"},"CountMetric":{"properties":{"change_percent":{"type":"number"},"current_count":{"format":"int64","type":"integer"},"previous_count":{"format":"int64","type":"integer"}},"required":["current_count"],"type":"object"},"CountProvenance":{"properties":{"external_actor_id":{"type":"string"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"source_system":{"anyOf":[{"$ref":"#/components/schemas/InventorySourceSystem"},{"type":"null"}]}},"required":["source_system"],"type":"object"},"CreateAPIKeyRequest":{"properties":{"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"name":{"type":"string"},"sandbox_id":{"type":"string"},"scopes":{"items":{"enum":["accounts.api_keys.read","accounts.api_keys.write","accounts.devices.read","accounts.devices.write","accounts.organizations.read","accounts.organizations.write","analytics.read","capabilities.read","checkouts.checkout_sessions.read","checkouts.checkout_sessions.write","checkouts.payment_links.read","checkouts.payment_links.write","commerce.bundles.read","commerce.bundles.write","commerce.catalog.read","commerce.catalog.write","commerce.credit_notes.read","commerce.credit_notes.write","commerce.delivery.read","commerce.delivery.write","commerce.inventory.read","commerce.inventory.write","commerce.inventory_locations.write","commerce.inventory_policies.write","commerce.inventory_reservations.write","commerce.invoices.read","commerce.invoices.write","commerce.orders.read","commerce.orders.write","commerce.products.read","commerce.products.write","commerce.promotions.read","commerce.promotions.write","commerce.refunds.read","commerce.refunds.tax_overrides.write","commerce.refunds.write","commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write","commerce.subscription_plans.read","commerce.subscription_plans.write","commerce.subscriptions.read","commerce.subscriptions.write","customers.read","customers.sessions.write","customers.write","developer.feedback_reports.read","developer.feedback_reports.write","developer.partner_apps.read","developer.partner_apps.write","developer.request_logs.self.detail.read","developer.request_logs.self.read","developer.resource_timelines.read","developer.sandboxes.read","developer.sandboxes.write","merchant_billing.read","merchants.account_sessions.write","merchants.locations.read","merchants.locations.write","merchants.onboarding.read","merchants.onboarding.write","merchants.profile.read","merchants.profile.write","money_movement.balance_transactions.read","money_movement.balances.read","money_movement.payout_settings.read","money_movement.payout_settings.write","money_movement.payouts.read","money_movement.payouts.write","payments.disputes.read","payments.payment_intents.read","payments.payment_intents.write","payments.payment_method_domains.read","payments.payment_method_domains.write","payments.payment_methods.read","payments.payment_methods.write","payments.payment_options.read","reports.read","reports.write","risk.controls.write","risk.read","risk.reviews.write","settings.read","settings.write","webhooks.read","webhooks.write"],"type":"string","x-enum-descriptions":["Accounts.api keys.read.","Accounts.api keys.write.","Accounts.devices.read.","Accounts.devices.write.","Accounts.organizations.read.","Accounts.organizations.write.","Analytics.read.","Capabilities.read.","Checkouts.checkout sessions.read.","Checkouts.checkout sessions.write.","Checkouts.payment links.read.","Checkouts.payment links.write.","Commerce.bundles.read.","Commerce.bundles.write.","Commerce.catalog.read.","Commerce.catalog.write.","Commerce.credit notes.read.","Commerce.credit notes.write.","Commerce.delivery.read.","Commerce.delivery.write.","Commerce.inventory.read.","Commerce.inventory.write.","Commerce.inventory locations.write.","Commerce.inventory policies.write.","Commerce.inventory reservations.write.","Commerce.invoices.read.","Commerce.invoices.write.","Commerce.orders.read.","Commerce.orders.write.","Commerce.products.read.","Commerce.products.write.","Commerce.promotions.read.","Commerce.promotions.write.","Commerce.refunds.read.","Commerce.refunds.tax overrides.write.","Commerce.refunds.write.","Commerce.return policies.write.","Commerce.return reasons.write.","Commerce.returns.decisions.write.","Commerce.returns.operations.write.","Commerce.returns.process.write.","Commerce.returns.read.","Commerce.returns.resolutions.write.","Commerce.returns.write.","Commerce.subscription plans.read.","Commerce.subscription plans.write.","Commerce.subscriptions.read.","Commerce.subscriptions.write.","Customers.read.","Customers.sessions.write.","Customers.write.","Developer.feedback reports.read.","Developer.feedback reports.write.","Developer.partner apps.read.","Developer.partner apps.write.","Developer.request logs.self.detail.read.","Developer.request logs.self.read.","Developer.resource timelines.read.","Developer.sandboxes.read.","Developer.sandboxes.write.","Merchant billing.read.","Merchants.account sessions.write.","Merchants.locations.read.","Merchants.locations.write.","Merchants.onboarding.read.","Merchants.onboarding.write.","Merchants.profile.read.","Merchants.profile.write.","Money movement.balance transactions.read.","Money movement.balances.read.","Money movement.payout settings.read.","Money movement.payout settings.write.","Money movement.payouts.read.","Money movement.payouts.write.","Payments.disputes.read.","Payments.payment intents.read.","Payments.payment intents.write.","Payments.payment method domains.read.","Payments.payment method domains.write.","Payments.payment methods.read.","Payments.payment methods.write.","Payments.payment options.read.","Reports.read.","Reports.write.","Risk.controls.write.","Risk.read.","Risk.reviews.write.","Settings.read.","Settings.write.","Webhooks.read.","Webhooks.write."],"x-flint-enum":"closed"},"type":"array"}},"required":["name","scopes"],"type":"object"},"CreateAPIKeyResponse":{"properties":{"data":{"$ref":"#/components/schemas/APIKeyWithSecret"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CreateBundleComponentInput":{"properties":{"delivery_profile_id":{"type":"string"},"position":{"format":"int32","minimum":0,"type":"integer"},"quantity":{"default":1,"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","maximum":9999,"minimum":1,"type":"integer"},"variant_id":{"pattern":"^var_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"required":["variant_id"],"type":"object"},"CreateBundleRequest":{"properties":{"barcode":{"type":"string"},"categories":{"items":{"maxLength":100,"minLength":1,"type":"string"},"maxItems":100,"type":"array"},"components":{"items":{"$ref":"#/components/schemas/CreateBundleComponentInput"},"type":"array"},"description":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"images":{"description":"The complete desired gallery in display order. The first image is primary. Send [] to clear the gallery.","items":{"$ref":"#/components/schemas/ImageInput"},"maxItems":8,"minItems":0,"type":"array"},"line_item_tax_category":{"description":"Flint line-item tax category.","enum":["general","physical_goods","digital_goods","software","saas","services","professional_services","food","prepared_food","clothing","medical_goods","admission"],"type":"string","x-enum-descriptions":["General.","Physical goods.","Digital goods.","Software.","Saas.","Services.","Professional services.","Food.","Prepared food.","Clothing.","Medical goods.","Admission."],"x-flint-enum":"closed"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"modifier_set_id":{"description":"Attached modifier set. Send null on update to remove it.","pattern":"^ms_[0-9A-HJKMNP-TV-Z]{26}$","type":["string","null"]},"name":{"type":"string"},"sku":{"type":"string"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"taxable":{"type":"boolean"},"unit_price_money":{"$ref":"#/components/schemas/Money"}},"required":["name","unit_price_money"],"type":"object"},"CreateCategoryRequest":{"properties":{"description":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"handle":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"}},"required":["name"],"type":"object"},"CreateCheckoutDeliveryQuoteRequest":{"properties":{"basis_delivery_quote_id":{"type":"string"},"buyer_location":{"$ref":"#/components/schemas/DeliveryBuyerLocationInput"},"destination_address":{"$ref":"#/components/schemas/DeliveryAddressInput"},"expected_delivery_selection_id":{"description":"Current delivery selection ID used for compare-and-swap. Send null to assert that no selection exists.","type":["string","null"]},"inventory_assignments":{"items":{"$ref":"#/components/schemas/DeliveryInventoryAssignmentRequest"},"type":"array"},"method_results":{"items":{"$ref":"#/components/schemas/CallerSuppliedDeliveryMethodResultRequest"},"type":"array"},"pickup_location_id":{"type":"string"},"tier_key":{"description":"Caller-defined nonnegative lookup key used by methods whose tiered pricing basis is caller.tier_key. Merchant authentication is required.","format":"int64","minimum":0,"type":"integer"}},"required":["expected_delivery_selection_id"],"type":"object"},"CreateCheckoutSessionRequest":{"oneOf":[{"not":{"anyOf":[{"required":["quick_pay_item"]},{"required":["plan_id"]},{"required":["payment_intent_id"]}]},"required":["order_id"]},{"not":{"anyOf":[{"required":["order_id"]},{"required":["plan_id"]},{"required":["payment_intent_id"]},{"required":["replace_checkout_session_id"]}]},"required":["quick_pay_item"]},{"not":{"anyOf":[{"required":["order_id"]},{"required":["quick_pay_item"]},{"required":["payment_intent_id"]},{"required":["replace_checkout_session_id"]}]},"required":["plan_id"]},{"not":{"anyOf":[{"required":["order_id"]},{"required":["quick_pay_item"]},{"required":["plan_id"]},{"required":["replace_checkout_session_id"]}]},"required":["payment_intent_id"]}],"properties":{"custom_text":{"$ref":"#/components/schemas/CheckoutCustomTextWriteConfig"},"customer_collection":{"$ref":"#/components/schemas/CheckoutCustomerConfig"},"delivery_method_ids":{"description":"Immutable delivery method assignment for this checkout. Omit the field to use the configured checkout default. Send an explicit empty array only when the order has no delivery obligations.","items":{"type":"string"},"type":"array"},"expiration":{"$ref":"#/components/schemas/CheckoutExpirationConfig"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"legal":{"$ref":"#/components/schemas/CheckoutLegalConfig"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"payment_intent_id":{"description":"Existing orderless PaymentIntent to collect in hosted checkout. Its amount, currency, customer, and payment options remain authoritative. Direct collection currently supports automatic-capture card, Apple Pay, and Google Pay payments.","type":"string"},"payments":{"$ref":"#/components/schemas/CheckoutPaymentConfig"},"plan_id":{"type":"string"},"promotion_config":{"$ref":"#/components/schemas/CheckoutPromotionConfig"},"quick_pay_item":{"$ref":"#/components/schemas/CheckoutQuickPayItemInput"},"redirects":{"$ref":"#/components/schemas/CheckoutRedirectsConfig"},"replace_checkout_session_id":{"description":"Expected current open checkout session to replace atomically. Allowed only with order_id. A stale value returns CHECKOUT_SESSION_CURRENT_CHANGED and the current session ID; active payment work returns CHECKOUT_PAYMENT_RESOLVING.","type":"string"},"surface":{"default":"hosted","description":"Defaults to hosted when omitted. Use embedded for a merchant-owned presentation.","enum":["hosted","embedded"],"type":"string","x-enum-descriptions":["Hosted.","Embedded."],"x-flint-enum":"closed"},"tax":{"$ref":"#/components/schemas/CheckoutTaxConfig"},"theme":{"$ref":"#/components/schemas/ThemeConfig"},"tip":{"$ref":"#/components/schemas/CheckoutTipConfig"}},"type":"object"},"CreateCreditNoteAllocationRequest":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money","description":"Credit to apply, no more than the credit note's unallocated_money or the invoice's outstanding balance."},"expected_version":{"format":"int64","minimum":1,"type":"integer"}},"required":["amount_money"],"type":"object"},"CreateCreditNoteRefundRequest":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"expected_version":{"format":"int64","minimum":1,"type":"integer"},"reason":{"enum":["duplicate","fraudulent","requested_by_customer","defective_product","wrong_item_shipped","never_received","not_as_described","arrived_too_late","customer_changed_mind","better_price_found","accidental_order","other"],"type":"string","x-enum-descriptions":["Duplicate.","Fraudulent.","Requested by customer.","Defective product.","Wrong item shipped.","Never received.","Not as described.","Arrived too late.","Customer changed mind.","Better price found.","Accidental order.","Other."],"x-flint-enum":"closed"},"reason_message":{"type":"string"}},"required":["reason"],"type":"object"},"CreateCreditNoteRequest":{"properties":{"credit_note_lines":{"description":"Initial draft corrections. Omit or send [] to create an empty draft. Null is not accepted.","items":{"$ref":"#/components/schemas/CreditNoteLineRequest"},"type":"array"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"invoice_id":{"description":"The invoice to correct. It has to be past draft and not voided.","type":"string"},"memo":{"maxLength":4096,"type":"string"},"reason":{"enum":["returned_goods","order_adjustment","billing_error","goodwill","other"],"type":"string","x-enum-descriptions":["Returned goods.","Order adjustment.","Billing error.","Goodwill.","Other."],"x-flint-enum":"closed"}},"required":["invoice_id","reason"],"type":"object"},"CreateCustomerAddressRequest":{"properties":{"address":{"$ref":"#/components/schemas/PostalAddress"},"is_default_billing":{"type":"boolean"},"is_default_shipping":{"type":"boolean"},"label":{"type":"string"},"phone":{"type":"string"},"recipient_name":{"type":"string"}},"required":["address","recipient_name"],"type":"object"},"CreateCustomerRequest":{"properties":{"billing_address":{"$ref":"#/components/schemas/Address"},"default_invoice_payment_term_id":{"type":"string"},"email":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"group_id":{"type":"string"},"internal_note":{"type":"string"},"is_verified":{"type":"boolean"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"phone":{"type":"string"},"shipping_address":{"$ref":"#/components/schemas/Address"},"tax_exempt":{"type":"boolean"},"tax_identity":{"$ref":"#/components/schemas/TaxIdentityInput"}},"required":["email"],"type":"object"},"CreateCustomerSessionRequest":{"properties":{"account_url_expires_in_seconds":{"format":"int64","maximum":3600,"minimum":60,"type":"integer"},"customer_id":{"type":"string"},"expires_in_seconds":{"format":"int64","maximum":86400,"minimum":300,"type":"integer"},"refresh_expires_in_seconds":{"format":"int64","maximum":2592000,"minimum":3600,"type":"integer"}},"required":["customer_id"],"type":"object"},"CreateDeliveryFulfillmentDetails":{"properties":{"carrier":{"type":"string"},"courier_pickup_at":{"description":"Time at which the courier collected the order.","format":"date-time","type":"string"},"courier_pickup_window_duration_seconds":{"description":"Width of the promised courier pickup window, from 0 to 86400 seconds.","format":"int64","maximum":86400,"minimum":0,"type":"integer"},"courier_provider_name":{"description":"Delivery network or merchant fleet provider handling the job.","maxLength":255,"type":"string"},"courier_support_phone_number":{"description":"Buyer-safe support number for the courier or merchant fleet.","maxLength":30,"type":"string"},"dispatched_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"dropoff_notes":{"description":"Driver-facing notes for the final handoff.","maxLength":2048,"type":"string"},"expires_at":{"description":"Deadline after which an undelivered job should enter merchant review.","format":"date-time","type":"string"},"external_delivery_id":{"description":"Stable delivery job ID owned by the courier or merchant dispatch system.","maxLength":255,"type":"string"},"instructions":{"type":"string"},"no_contact":{"description":"Whether the buyer requested a no-contact handoff.","type":"boolean"},"prep_time_duration_seconds":{"description":"Expected preparation time before courier pickup, from 0 to 86400 seconds.","format":"int64","maximum":86400,"minimum":0,"type":"integer"},"ready_at":{"description":"Time at which the order became ready for courier pickup.","format":"date-time","type":"string"},"service_area_id":{"type":"string"},"tracking_url":{"description":"Absolute HTTPS carrier tracking URL. Embedded URL credentials are rejected.","type":"string"},"window_end_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"window_start_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"type":"object"},"CreateDeliveryLocationSetRequest":{"additionalProperties":false,"properties":{"configuration":{"$ref":"#/components/schemas/DeliveryLocationSetConfiguration"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"}},"required":["name","configuration"],"type":"object"},"CreateDeliveryMethodRequest":{"additionalProperties":false,"discriminator":{"propertyName":"type"},"oneOf":[{"properties":{"configuration":{"allOf":[{"$ref":"#/components/schemas/DeliveryMethodConfigurationInput"},{"properties":{"public_details":{"not":{"required":["pickup_mode"]},"properties":{"service_level":{"enum":["economy","standard","expedited","express","overnight","same_day"],"type":"string","x-enum-descriptions":["Economy.","Standard.","Expedited.","Express.","Overnight.","Same day."],"x-flint-enum":"closed"}},"type":"object"}}}]},"type":{"enum":["shipment"],"type":"string","x-enum-descriptions":["Shipment."],"x-flint-enum":"closed"}},"required":["type","configuration"]},{"properties":{"configuration":{"allOf":[{"$ref":"#/components/schemas/DeliveryMethodConfigurationInput"},{"properties":{"public_details":{"not":{"required":["pickup_mode"]},"properties":{"service_level":{"enum":["on_demand","same_day","scheduled"],"type":"string","x-enum-descriptions":["On demand.","Same day.","Scheduled."],"x-flint-enum":"closed"}},"type":"object"}}}]},"type":{"enum":["local_delivery"],"type":"string","x-enum-descriptions":["Local delivery."],"x-flint-enum":"closed"}},"required":["type","configuration"]},{"properties":{"configuration":{"allOf":[{"$ref":"#/components/schemas/DeliveryMethodConfigurationInput"},{"properties":{"origin":{"allOf":[{"$ref":"#/components/schemas/DeliveryMethodOriginSelectorInput"},{"properties":{"type":{"enum":["pickup_location_collection"],"type":"string","x-enum-descriptions":["Pickup location collection."],"x-flint-enum":"closed"}}}]},"public_details":{"not":{"required":["service_level"]},"properties":{"pickup_mode":{"enum":["in_store","curbside","locker","other"],"type":"string","x-enum-descriptions":["In store.","Curbside.","Locker.","Other."],"x-flint-enum":"closed"}},"required":["pickup_mode"],"type":"object"}},"required":["origin","public_details"]}]},"type":{"enum":["pickup"],"type":"string","x-enum-descriptions":["Pickup."],"x-flint-enum":"closed"}},"required":["type","configuration"]}],"properties":{"configuration":{"$ref":"#/components/schemas/DeliveryMethodConfigurationCreateInput"},"description":{"type":"string"},"display_position":{"format":"int32","type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"recommendation_priority":{"format":"int32","type":"integer"},"status":{"enum":["inactive","active"],"type":"string","x-enum-descriptions":["Inactive.","Active."],"x-flint-enum":"open"},"type":{"enum":["shipment","local_delivery","pickup"],"type":"string","x-enum-descriptions":["Shipment.","Local delivery.","Pickup."],"x-flint-enum":"closed"}},"required":["type","name","configuration"],"type":"object"},"CreateDeliveryPreviewRequest":{"additionalProperties":false,"properties":{"buyer_location":{"$ref":"#/components/schemas/DeliveryBuyerLocationInput"},"currency":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"},"delivery_method_ids":{"items":{"type":"string"},"type":"array"},"destination_address":{"$ref":"#/components/schemas/DeliveryAddressInput"},"inventory_routing_source":{"$ref":"#/components/schemas/DeliveryPreviewRoutingSource"},"line_items":{"items":{"$ref":"#/components/schemas/CreateOrderLineItem"},"maxItems":100,"minItems":1,"type":"array"},"pickup_location_id":{"type":"string"},"pricing_context":{"additionalProperties":{"type":"string"},"type":"object"}},"required":["currency","delivery_method_ids","line_items"],"type":"object"},"CreateDeliveryProfileRequest":{"additionalProperties":false,"properties":{"configuration":{"$ref":"#/components/schemas/DeliveryProfileConfigurationInput"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"}},"required":["name","configuration"],"type":"object"},"CreateDeliveryRateCallbackRequest":{"additionalProperties":false,"properties":{"configuration":{"$ref":"#/components/schemas/DeliveryRateCallbackConfiguration"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"name":{"type":"string"}},"required":["name","configuration"],"type":"object"},"CreateDeliverySelectionChoiceRequest":{"additionalProperties":false,"properties":{"delivery_choice_group_id":{"type":"string"},"delivery_option_id":{"type":"string"},"input":{"$ref":"#/components/schemas/DeliverySelectionInstructionsInput"}},"required":["delivery_choice_group_id","delivery_option_id"],"type":"object"},"CreateDeliverySelectionRequest":{"properties":{"choices":{"items":{"$ref":"#/components/schemas/CreateDeliverySelectionChoiceRequest"},"type":"array"},"delivery_quote_id":{"type":"string"},"destination_address":{"$ref":"#/components/schemas/Address"},"expected_delivery_selection_id":{"description":"Current delivery selection ID used for compare-and-swap. Send null to assert that no selection exists.","type":["string","null"]},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"external_system":{"type":"string"},"recipient":{"$ref":"#/components/schemas/DeliverySelectionRecipientRequest"}},"required":["choices","delivery_quote_id","expected_delivery_selection_id"],"type":"object"},"CreateDeliveryZoneRequest":{"additionalProperties":false,"properties":{"configuration":{"$ref":"#/components/schemas/DeliveryZoneConfiguration"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"}},"required":["name","configuration"],"type":"object"},"CreateDemoSessionRequest":{"properties":{"template":{"type":"string"}},"type":"object"},"CreateDeviceRequest":{"properties":{"hardware_fingerprint":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"}},"required":["name"],"type":"object"},"CreateDeviceResponse":{"properties":{"data":{"$ref":"#/components/schemas/CreateDeviceResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CreateDeviceResult":{"properties":{"already_existed":{"type":"boolean"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"device_id":{"readOnly":true,"type":"string"},"hardware_fingerprint":{"type":"string"},"location_id":{"type":"string"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"status":{"enum":["active","deleted"],"readOnly":true,"type":"string","x-enum-descriptions":["Active.","Deleted."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"}},"required":["device_id","name","status"],"type":"object"},"CreateDigitalFulfillmentDetails":{"properties":{"delivery_url":{"type":"string"}},"type":"object"},"CreateEmailChangeRequest":{"properties":{"new_email":{"type":"string"}},"required":["new_email"],"type":"object"},"CreateFeedbackReportRequest":{"additionalProperties":false,"oneOf":[{"properties":{"kind":{"enum":["rating"],"type":"string","x-enum-descriptions":["Structured positive, negative, or neutral sentiment, with optional narrative context."],"x-flint-enum":"closed"}},"required":["kind","surface","sentiment"]},{"properties":{"kind":{"enum":["papercut","bug","feature_request","praise","other"],"type":"string","x-enum-descriptions":["An existing Flint workflow works, but avoidable friction or unclear developer experience makes it harder than necessary.","Flint behavior is broken, incorrect, or contradicts its public contract.","The caller needs a capability Flint does not provide.","Narrative positive feedback about an experience.","Feedback that does not match the other classifications."],"x-flint-enum":"closed"}},"required":["kind","surface","summary"]}],"properties":{"actual_behavior":{"maxLength":4000,"minLength":1,"type":"string"},"canonical_command":{"maxLength":200,"minLength":1,"pattern":"^[a-z][a-z0-9]*(?:[.-][a-z0-9]+)*$","type":"string"},"code_location":{"maxLength":500,"minLength":1,"type":"string"},"component":{"maxLength":128,"minLength":1,"type":"string"},"description":{"maxLength":8000,"minLength":1,"type":"string"},"expected_behavior":{"maxLength":4000,"minLength":1,"type":"string"},"kind":{"enum":["papercut","bug","feature_request","rating","praise","other"],"type":"string","x-enum-descriptions":["An existing Flint workflow works, but avoidable friction or unclear developer experience makes it harder than necessary.","Flint behavior is broken, incorrect, or contradicts its public contract.","The caller needs a capability Flint does not provide.","Structured positive, negative, or neutral sentiment, with optional narrative context.","Narrative positive feedback about an experience.","Feedback that does not match the other classifications."],"x-flint-enum":"closed"},"related_request_id":{"maxLength":255,"minLength":1,"type":"string"},"related_resource_ids":{"items":{"minLength":1,"type":"string"},"maxItems":20,"type":"array","uniqueItems":true},"reporter_kind":{"enum":["human","ai_agent"],"type":"string","x-enum-descriptions":["Human.","Ai agent."],"x-flint-enum":"closed"},"reporting_client":{"$ref":"#/components/schemas/FeedbackReportingClient"},"reproduction_steps":{"items":{"maxLength":1000,"minLength":1,"type":"string"},"maxItems":20,"type":"array","uniqueItems":true},"sentiment":{"enum":["positive","negative","neutral"],"type":"string","x-enum-descriptions":["Positive.","Negative.","Neutral."],"x-flint-enum":"closed"},"summary":{"maxLength":200,"minLength":1,"type":"string"},"surface":{"enum":["api","cli","mcp","sdk","docs","dashboard","checkout","payment_links","webhooks","onboarding","mobile","other"],"type":"string","x-enum-descriptions":["Api.","Cli.","Mcp.","Sdk.","Docs.","Dashboard.","Checkout.","Payment links.","Webhooks.","Onboarding.","Mobile.","Other."],"x-flint-enum":"closed"},"surface_route":{"maxLength":500,"minLength":1,"type":"string"}},"required":["kind","surface"],"type":"object"},"CreateFulfillmentEventRequest":{"properties":{"buyer_notification_behavior":{"description":"Controls buyer email handling. Omit or use send to send when recipient, template, and deduplication rules allow it. Use suppress when another system owns buyer messaging.","enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"custom_details":{"additionalProperties":{"type":"string"},"type":"object"},"event_type":{"enum":["shipped","in_transit","out_for_delivery","delivered","delivery_attempted","tracking_updated","exception","returned","custom"],"type":"string","x-enum-descriptions":["Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Tracking updated.","Exception.","Returned.","Custom."],"x-flint-enum":"closed"},"external_event_id":{"type":"string"},"external_status":{"type":"string"},"external_system":{"type":"string"},"location_description":{"type":"string"},"message":{"type":"string"},"occurred_at":{"description":"Provider event timestamp.","format":"date-time","type":"string"},"package_id":{"description":"Nested package associated with this observational event. Flint resolves and validates its shipment and fulfillment ownership.","type":"string"},"shipment_id":{"description":"Nested shipment associated with this observational event. Flint validates that it belongs to the fulfillment in the path.","type":"string"}},"required":["event_type"],"type":"object"},"CreateFulfillmentRequest":{"allOf":[{"anyOf":[{"not":{"required":["shipment"]}},{"properties":{"type":{"enum":["shipment"],"x-enum-descriptions":["Shipment."],"x-flint-enum":"closed"}}}]}],"description":"Provide at most one fulfillment details object: pickup_details, local_delivery_details, digital_details, or service_details. Shipment execution details belong to shipments and packages.","oneOf":[{"not":{"anyOf":[{"required":["pickup_details"]},{"required":["local_delivery_details"]},{"required":["digital_details"]},{"required":["service_details"]}]}},{"required":["pickup_details"]},{"required":["local_delivery_details"]},{"required":["digital_details"]},{"required":["service_details"]}],"properties":{"customer_id":{"type":"string"},"device_id":{"type":"string"},"digital_details":{"$ref":"#/components/schemas/CreateDigitalFulfillmentDetails"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"line_items":{"items":{"$ref":"#/components/schemas/FulfillmentLineItemInput"},"minItems":1,"type":"array"},"local_delivery_details":{"$ref":"#/components/schemas/CreateDeliveryFulfillmentDetails"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"pickup_details":{"$ref":"#/components/schemas/CreatePickupFulfillmentDetails"},"recipient":{"$ref":"#/components/schemas/FulfillmentRecipient"},"service_details":{"$ref":"#/components/schemas/CreateServiceFulfillmentDetails"},"shipment":{"$ref":"#/components/schemas/FulfillmentPackagingInput","description":"Creates one outbound shipment and one package atomically with the fulfillment. packaging must be single_package. The package receives the full quantities of only the submitted line_items. Requires type shipment. Omission creates no shipment or package. Tracking does not mark the package shipped. Package tracking notifications are requested when buyer_notification_behavior is omitted; use suppress to prevent buyer messages from this creation."},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"}},"required":["line_items","type"],"type":"object"},"CreateFulfillmentResponse":{"properties":{"data":{"$ref":"#/components/schemas/CreateFulfillmentResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data","request_id"],"type":"object"},"CreateFulfillmentResult":{"properties":{"active_payment_attempt":{"$ref":"#/components/schemas/OrderPaymentAttempt","readOnly":true},"applied_discounts":{"items":{"$ref":"#/components/schemas/AppliedDiscount"},"readOnly":true,"type":"array"},"authorization_amounts":{"$ref":"#/components/schemas/OrderAuthorizationAmounts","readOnly":true},"buyer_email":{"readOnly":true,"type":"string"},"buyer_note":{"type":"string"},"charges":{"items":{"$ref":"#/components/schemas/OrderCharge"},"readOnly":true,"type":"array"},"checkout_session_ids":{"items":{"type":"string"},"readOnly":true,"type":"array"},"closed_reason":{"description":"Internal reason supplied when the order was closed. This is not shown to the buyer.","readOnly":true,"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"customer":{"anyOf":[{"$ref":"#/components/schemas/ExpandedCustomerSummary"},{"type":"null"}],"readOnly":true},"customer_id":{"type":"string"},"delivery_destination":{"$ref":"#/components/schemas/OrderDeliveryDestination","description":"The shipment or local-delivery destination committed for this order. Payment freezes this value; fulfillment recipient changes do not replace it."},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"fulfillment_id":{"type":"string"},"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled","not_applicable","closed"],"readOnly":true,"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled.","Not applicable.","Closed."],"x-flint-enum":"open"},"fulfillments":{"items":{"$ref":"#/components/schemas/Fulfillment"},"readOnly":true,"type":"array"},"internal_note":{"type":"string"},"inventory_exception_status":{"enum":["paid_inventory_failed","resolved"],"readOnly":true,"type":"string","x-enum-descriptions":["Paid inventory failed.","Resolved."],"x-flint-enum":"open"},"inventory_reservation_id":{"description":"The reservation holding stock for this order, when one exists.","readOnly":true,"type":"string"},"inventory_routing_source":{"$ref":"#/components/schemas/InventoryRoutingSource","description":"Where this order's tracked demand is routed. Required before an order containing tracked variants can hold stock."},"line_items":{"items":{"$ref":"#/components/schemas/OrderLineItem"},"readOnly":true,"type":"array"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"readOnly":true,"type":"string"},"order_number":{"readOnly":true,"type":"string"},"origin":{"enum":["virtual_terminal","payment_link","checkout","api","subscription"],"readOnly":true,"type":"string","x-enum-descriptions":["Virtual terminal.","Payment link.","Checkout.","Api.","Subscription."],"x-flint-enum":"closed"},"package_id":{"type":"string"},"package_items":{"description":"Canonical package items created with this fulfillment. Empty when shipment was omitted. Subsequent edits use the package item routes.","items":{"$ref":"#/components/schemas/PackageItem"},"type":"array"},"payment_collection":{"$ref":"#/components/schemas/PaymentCollection","readOnly":true},"payment_intent_ids":{"items":{"type":"string"},"readOnly":true,"type":"array"},"payment_intents":{"items":{"$ref":"#/components/schemas/ExpandedPaymentIntentSummary"},"readOnly":true,"type":"array"},"payment_status":{"enum":["unpaid","partially_paid","paid"],"readOnly":true,"type":"string","x-enum-descriptions":["Unpaid.","Partially paid.","Paid."],"x-flint-enum":"open"},"plan_id":{"readOnly":true,"type":"string"},"pricing_amounts":{"$ref":"#/components/schemas/PricingAmounts","readOnly":true},"refund_ids":{"items":{"type":"string"},"readOnly":true,"type":"array"},"refund_status":{"enum":["none","partially_refunded","refunded"],"readOnly":true,"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"requested_tip":{"$ref":"#/components/schemas/RequestedTip"},"settlement_amounts":{"$ref":"#/components/schemas/SettlementAmounts","readOnly":true},"setup_collection":{"$ref":"#/components/schemas/PaymentCollection","readOnly":true},"shipment_id":{"type":"string"},"status":{"enum":["open","closed"],"readOnly":true,"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"},"subscription":{"anyOf":[{"$ref":"#/components/schemas/ExpandedSubscriptionSummary"},{"type":"null"}],"readOnly":true},"subscription_id":{"readOnly":true,"type":"string"},"subscription_plan":{"anyOf":[{"$ref":"#/components/schemas/ExpandedSubscriptionPlanSummary"},{"type":"null"}],"readOnly":true},"tax":{"$ref":"#/components/schemas/OrderTax","readOnly":true},"tips":{"items":{"$ref":"#/components/schemas/Tip"},"readOnly":true,"type":"array"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"}},"required":["fulfillment_id","line_items","order_id","package_items","payment_status","pricing_amounts","refund_status","settlement_amounts","status","tax"],"type":"object"},"CreateInlineModifierGroupInput":{"additionalProperties":false,"properties":{"allow_quantities":{"default":false,"type":"boolean"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"max_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"max_selected":{"format":"int32","type":"integer"},"max_total_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"min_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"min_selected":{"format":"int32","type":"integer"},"modifier_group_type":{"description":"Inferred as text when text configuration is supplied, otherwise list.","enum":["list","text"],"type":"string","x-enum-descriptions":["List.","Text."],"x-flint-enum":"closed"},"modifiers":{"items":{"$ref":"#/components/schemas/CreateModifierInput"},"type":"array"},"name":{"type":"string"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"text":{"$ref":"#/components/schemas/TextModifierConfigInput"}},"required":["name"],"type":"object"},"CreateInventoryAdjustmentRequest":{"properties":{"external_actor_id":{"type":"string"},"lines":{"items":{"$ref":"#/components/schemas/InventoryAdjustmentLineRequest"},"type":"array"},"note":{"type":"string"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"enum":["received_stock","damage","condition_changed","theft","loss","manual_correction","other"],"type":"string","x-enum-descriptions":["Received stock.","Damage.","Condition changed.","Theft.","Loss.","Manual correction.","Other."],"x-flint-enum":"closed"},"source_system":{"$ref":"#/components/schemas/InventorySourceSystemInput"}},"required":["lines","reason"],"type":"object"},"CreateInventoryAllocationPolicyRequest":{"additionalProperties":false,"properties":{"configuration":{"$ref":"#/components/schemas/InventoryAllocationPolicyConfiguration"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"status":{"default":"active","enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"}},"required":["configuration","name"],"type":"object"},"CreateInventoryCountRequest":{"additionalProperties":false,"properties":{"inventory_item_ids":{"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"location_id":{"type":"string"}},"required":["inventory_item_ids","location_id"],"type":"object"},"CreateInventoryItemRequest":{"properties":{"barcode":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"sku":{"type":"string"},"status":{"default":"active","enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"}},"required":["name"],"type":"object"},"CreateInventoryReceiptRequest":{"properties":{"external_actor_id":{"type":"string"},"lines":{"items":{"$ref":"#/components/schemas/InventoryReceiptLineInput"},"type":"array"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"source_system":{"$ref":"#/components/schemas/InventorySourceSystemInput"}},"required":["lines"],"type":"object"},"CreateInventoryReservationRequest":{"additionalProperties":false,"properties":{"assignments":{"items":{"$ref":"#/components/schemas/InventoryAssignment"},"type":"array"},"demands":{"items":{"$ref":"#/components/schemas/InventoryRoutingDemand"},"type":"array"},"destination_fingerprint":{"type":"string"},"inventory_routing_source":{"$ref":"#/components/schemas/InventoryRoutingSourceInput"},"owner":{"$ref":"#/components/schemas/InventoryReservationOwner"}},"required":["demands","inventory_routing_source","owner"],"type":"object"},"CreateInventoryTransferRequest":{"additionalProperties":false,"properties":{"destination_location_id":{"type":"string"},"external_reference":{"type":"string"},"lines":{"items":{"$ref":"#/components/schemas/InventoryTransferLineInput"},"maxItems":100,"minItems":1,"type":"array"},"note":{"type":"string"},"origin_location_id":{"type":"string"}},"required":["destination_location_id","lines","origin_location_id"],"type":"object"},"CreateInvoicePaymentTermRequest":{"additionalProperties":false,"properties":{"calculation":{"$ref":"#/components/schemas/InvoicePaymentTermCalculation"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"late_fee_policy":{"$ref":"#/components/schemas/InvoiceLateFeePolicy"},"name":{"type":"string"}},"required":["name","calculation"],"type":"object"},"CreateInvoiceQuickPayRequest":{"additionalProperties":false,"properties":{"buyer_note":{"type":"string"},"customer_id":{"type":"string"},"discounts":{"items":{"$ref":"#/components/schemas/CreateOrderDiscount"},"type":"array"},"internal_note":{"type":"string"},"line_items":{"items":{"$ref":"#/components/schemas/CreateOrderLineItem"},"minItems":1,"type":"array"},"requested_tip":{"$ref":"#/components/schemas/CreateOrderTip"}},"required":["line_items"],"type":"object"},"CreateInvoiceRequest":{"additionalProperties":false,"oneOf":[{"not":{"anyOf":[{"required":["quick_pay"]}]},"required":["order_id"]},{"not":{"anyOf":[{"required":["order_id"]}]},"required":["quick_pay"]}],"properties":{"cc_emails":{"items":{"type":"string"},"type":"array"},"collection":{"$ref":"#/components/schemas/InvoiceCollectionInput","default":{"mode":"merchant_default"}},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"footer":{"type":"string"},"memo":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"payment_due":{"$ref":"#/components/schemas/InvoicePaymentDueInput","default":{"type":"merchant_default"}},"po_number":{"type":"string"},"quick_pay":{"$ref":"#/components/schemas/CreateInvoiceQuickPayRequest"},"recipient_email":{"type":"string"},"reference":{"type":"string"},"remit_to_address":{"$ref":"#/components/schemas/Address"},"schedule_entries":{"description":"Complete draft payment schedule with at most 14 entries. Omission preserves the current or default schedule; [] clears the authored schedule. Null is not accepted. On PATCH, include invoice_schedule_entry_id to retain an entry and expected_version to detect concurrent edits.","items":{"$ref":"#/components/schemas/InvoiceScheduleEntryWrite"},"maxItems":14,"type":"array"},"scheduled_send_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"service_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"type":"object"},"CreateLocationRequest":{"properties":{"address":{"$ref":"#/components/schemas/LocationAddress"},"coordinate":{"$ref":"#/components/schemas/LocationCoordinate"},"coordinate_source":{"enum":["merchant_supplied","geocoded",null],"type":["string","null"],"x-enum-descriptions":["Merchant supplied.","Geocoded.","Null."],"x-flint-enum":"closed"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"inventory":{"$ref":"#/components/schemas/LocationInventoryInput"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"status":{"default":"active","enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"timezone":{"type":"string"}},"required":["address","name","timezone"],"type":"object"},"CreateModifierGroupRequest":{"properties":{"allow_quantities":{"default":false,"type":"boolean"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"max_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"max_selected":{"format":"int32","type":"integer"},"max_total_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"min_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"min_selected":{"format":"int32","type":"integer"},"modifier_group_type":{"description":"Inferred as text when text configuration is supplied, otherwise list.","enum":["list","text"],"type":"string","x-enum-descriptions":["List.","Text."],"x-flint-enum":"closed"},"modifiers":{"items":{"$ref":"#/components/schemas/CreateModifierInput"},"type":"array"},"name":{"type":"string"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"text":{"$ref":"#/components/schemas/TextModifierConfigInput"}},"required":["name"],"type":"object"},"CreateModifierInput":{"additionalProperties":false,"properties":{"default_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"line_item_tax_category":{"description":"Flint line-item tax category.","enum":["general","physical_goods","digital_goods","software","saas","services","professional_services","food","prepared_food","clothing","medical_goods","admission"],"type":"string","x-enum-descriptions":["General.","Physical goods.","Digital goods.","Software.","Saas.","Services.","Professional services.","Food.","Prepared food.","Clothing.","Medical goods.","Admission."],"x-flint-enum":"closed"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"position":{"format":"int32","type":"integer"},"selected_by_default":{"default":false,"type":"boolean"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"taxable":{"type":"boolean"},"unit_price_delta_money":{"$ref":"#/components/schemas/Money"}},"required":["name"],"type":"object"},"CreateModifierSetGroupInput":{"additionalProperties":false,"discriminator":{"propertyName":"source"},"oneOf":[{"not":{"required":["modifier_group"]},"properties":{"source":{"enum":["existing"],"type":"string","x-enum-descriptions":["Existing."],"x-flint-enum":"closed"}},"required":["source","modifier_group_id"]},{"not":{"required":["modifier_group_id"]},"properties":{"source":{"enum":["inline"],"type":"string","x-enum-descriptions":["Inline."],"x-flint-enum":"closed"}},"required":["source","modifier_group"]}],"properties":{"display_name":{"type":"string"},"max_selected":{"format":"int32","type":"integer"},"min_selected":{"format":"int32","type":"integer"},"modifier_group":{"$ref":"#/components/schemas/CreateInlineModifierGroupInput"},"modifier_group_id":{"pattern":"^mg_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"modifier_overrides":{"items":{"$ref":"#/components/schemas/ModifierOverride"},"type":"array"},"position":{"format":"int32","type":"integer"},"required":{"type":"boolean"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"source":{"description":"Use inline for a modifier group owned by this modifier set, or existing to reference an independent modifier group.","enum":["existing","inline"],"type":"string","x-enum-descriptions":["Existing.","Inline."],"x-flint-enum":"closed"}},"required":["source"],"type":"object"},"CreateModifierSetRequest":{"properties":{"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"modifier_groups":{"items":{"$ref":"#/components/schemas/CreateModifierSetGroupInput"},"type":"array"},"name":{"type":"string"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"}},"required":["name"],"type":"object"},"CreateOrderDiscount":{"additionalProperties":false,"oneOf":[{"not":{"anyOf":[{"required":["manual"]}]},"required":["promotion"]},{"not":{"anyOf":[{"required":["promotion"]}]},"required":["manual"]}],"properties":{"manual":{"$ref":"#/components/schemas/ManualDiscountInput"},"promotion":{"$ref":"#/components/schemas/PromotionRefInput"}},"type":"object"},"CreateOrderLineItem":{"additionalProperties":false,"oneOf":[{"not":{"anyOf":[{"required":["bundle_id"]},{"required":["name"]},{"required":["unit_price_money"]},{"required":["description"]},{"required":["image"]},{"required":["tax"]},{"required":["inventory_demands"]},{"required":["fulfillment"]}]},"required":["variant_id"]},{"not":{"anyOf":[{"required":["variant_id"]},{"required":["name"]},{"required":["unit_price_money"]},{"required":["description"]},{"required":["image"]},{"required":["tax"]},{"required":["inventory_demands"]},{"required":["fulfillment"]}]},"required":["bundle_id"]},{"not":{"anyOf":[{"required":["variant_id"]},{"required":["bundle_id"]}]},"required":["name","unit_price_money"]}],"properties":{"bundle_id":{"type":"string"},"description":{"type":"string"},"fulfillment":{"$ref":"#/components/schemas/LineItemFulfillmentInput"},"image":{"$ref":"#/components/schemas/ImageReferenceInput"},"inventory_demands":{"items":{"$ref":"#/components/schemas/OrderDraftLineItemInventoryDemandInput"},"type":"array"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"modifiers":{"items":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemModifierInput"},{"not":{"required":["order_line_item_modifier_id"]}}]},"type":"array"},"name":{"type":"string"},"quantity":{"default":1,"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"tax":{"$ref":"#/components/schemas/OrderDraftLineItemTaxInput"},"unit_price_money":{"$ref":"#/components/schemas/Money"},"variant_id":{"type":"string"}},"type":"object"},"CreateOrderPaymentIntentRequest":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"capture_method":{"enum":["automatic","manual"],"type":"string","x-enum-descriptions":["Automatic.","Manual."],"x-flint-enum":"closed"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"payment_options":{"items":{"type":"string"},"type":"array"},"payment_return_url":{"type":"string"},"payment_source_selection":{"$ref":"#/components/schemas/OrderPaymentSourceSelection"}},"type":"object"},"CreateOrderPaymentIntentResponse":{"properties":{"data":{"$ref":"#/components/schemas/CreateOrderPaymentIntentResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CreateOrderPaymentIntentResult":{"properties":{"payment_collection":{"$ref":"#/components/schemas/PaymentCollection"},"payment_intent":{"$ref":"#/components/schemas/PaymentIntent"}},"required":["payment_collection","payment_intent"],"type":"object"},"CreateOrderRequest":{"additionalProperties":false,"properties":{"buyer_note":{"type":"string"},"customer_id":{"type":"string"},"delivery_destination":{"$ref":"#/components/schemas/OrderDeliveryDestinationInput","description":"Shipment or local-delivery destination for an order created without a delivery selection."},"discounts":{"items":{"$ref":"#/components/schemas/CreateOrderDiscount"},"type":"array"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"internal_note":{"type":"string"},"inventory_routing_source":{"$ref":"#/components/schemas/OrderInventoryRoutingSourceInput"},"line_items":{"items":{"$ref":"#/components/schemas/CreateOrderLineItem"},"minItems":1,"type":"array"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"requested_tip":{"$ref":"#/components/schemas/CreateOrderTip","description":"Optional requested tip. Its effective amount must satisfy the CreateOrderTip limit."},"tax":{"$ref":"#/components/schemas/OrderTaxInput"}},"required":["line_items"],"type":"object"},"CreateOrderTip":{"additionalProperties":false,"description":"Requested tip expressed as either a flat amount or a percentage. Send exactly one of amount_money or percent.","oneOf":[{"not":{"anyOf":[{"required":["percent"]}]},"required":["amount_money"]},{"not":{"anyOf":[{"required":["amount_money"]}]},"required":["percent"]}],"properties":{"amount_money":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"Flat requested tip in the order currency. The amount must be at least 1 minor unit; otherwise, Flint returns INVALID_TIP_AMOUNT. For USD orders, the maximum is the larger of $1,000 or the post-discount merchandise subtotal.","properties":{"amount":{"minimum":1}}},"description":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"percent":{"description":"Requested tip percentage from 1 through 100, calculated from the post-discount merchandise subtotal.","maximum":100,"minimum":1,"multipleOf":0.0001,"type":"number"}},"type":"object"},"CreateOrganizationRequest":{"properties":{"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"parent_organization_id":{"type":"string"}},"required":["name"],"type":"object"},"CreatePackageItemRequest":{"properties":{"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_line_item_id":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"}},"required":["order_line_item_id","quantity"],"type":"object"},"CreatePackageRequest":{"properties":{"buyer_notification_behavior":{"description":"Controls buyer email handling. Omit or use send to send when recipient, template, and deduplication rules allow it. Use suppress when another system owns buyer messaging. On create, tracking fields also record an initial tracking_updated fulfillment event; tracking PATCH requests always record tracking_updated events.","enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"carrier":{"type":"string"},"dimensions":{"$ref":"#/components/schemas/ShippingDimensions"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system. Caller-owned package identifier in external_system. Set with external_system to enable duplicate detection and replay for that provider reference.","maxLength":255,"minLength":1,"type":"string"},"external_system":{"description":"External carrier, aggregator, or fulfillment platform name for this package. Set with external_reference_id to enable duplicate detection and replay for that provider reference; without external_reference_id this is stored as provenance only.","type":"string"},"label_url":{"description":"Merchant or integration supplied HTTPS shipping-label URL for authenticated merchant workflows. Non-Flint URLs must include external_system for provenance. Flint does not currently manage label file hosting or buyer-facing label downloads.","type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"service_code":{"type":"string"},"status_reason":{"type":"string"},"tracking_number":{"type":"string"},"tracking_url":{"description":"Absolute HTTPS carrier tracking URL. Embedded URL credentials are rejected.","type":"string"},"weight":{"$ref":"#/components/schemas/ShippingWeight"}},"type":"object"},"CreatePackageResponse":{"properties":{"data":{"$ref":"#/components/schemas/CreatePackageResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CreatePackageResult":{"properties":{"fulfillment_event":{"$ref":"#/components/schemas/FulfillmentEvent"},"fulfillment_notifications":{"items":{"$ref":"#/components/schemas/FulfillmentNotification"},"type":"array"},"package":{"$ref":"#/components/schemas/Package"},"replayed":{"type":"boolean"}},"required":["package"],"type":"object"},"CreatePartnerAppRequest":{"properties":{"api_version":{"type":"string"},"app_type":{"type":"string"},"default_requested_permissions":{"items":{"type":"string"},"type":"array"},"name":{"type":"string"},"permission_manifest":{"items":{"$ref":"#/components/schemas/PartnerAppPermissionManifestEntry"},"type":"array"},"redirect_uris":{"items":{"type":"string"},"type":"array"},"visibility":{"type":"string"}},"required":["name","permission_manifest","redirect_uris"],"type":"object"},"CreatePartnerAppResponse":{"properties":{"data":{"$ref":"#/components/schemas/PartnerAppWithSecret"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CreatePaymentIntentRequest":{"allOf":[{"else":{"not":{"required":["transaction_purpose"]}},"if":{"properties":{"payment_options":{"contains":{"const":"ach_debit"},"type":"array"}},"required":["payment_options"]},"then":{"required":["transaction_purpose"]}},{"if":{"properties":{"payment_options":{"contains":{"const":"affirm"},"type":"array"}},"required":["payment_options"]},"then":{"required":["payment_return_url"]}}],"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"capture_method":{"enum":["automatic","manual"],"type":"string","x-enum-descriptions":["Automatic.","Manual."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"payment_options":{"items":{"enum":["card","apple_pay","google_pay","affirm","ach_debit"],"type":"string","x-enum-descriptions":["Card.","Apple pay.","Google pay.","Affirm.","Ach debit."],"x-flint-enum":"closed"},"minItems":1,"type":"array"},"payment_return_url":{"pattern":"\\S","type":"string"},"receipt_email":{"type":"string"},"tip_money":{"$ref":"#/components/schemas/Money"},"transaction_purpose":{"enum":["goods","services","other"],"type":"string","x-enum-descriptions":["Goods.","Services.","Other."],"x-flint-enum":"closed"}},"required":["amount_money","payment_options"],"type":"object"},"CreatePaymentIntentResponse":{"properties":{"data":{"$ref":"#/components/schemas/CreatePaymentIntentResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CreatePaymentIntentResult":{"properties":{"payment_collection":{"$ref":"#/components/schemas/PaymentCollection"},"payment_intent":{"$ref":"#/components/schemas/PaymentIntent"}},"required":["payment_collection","payment_intent"],"type":"object"},"CreatePaymentLinkRequest":{"properties":{"custom_fields":{"items":{"$ref":"#/components/schemas/PaymentLinkCustomFieldInput"},"type":"array"},"custom_text":{"$ref":"#/components/schemas/CheckoutCustomTextWriteConfig"},"customer_collection":{"$ref":"#/components/schemas/PaymentLinkCustomerConfig"},"delivery_method_ids":{"description":"Complete delivery method selection for the link. Send an empty array to clear it. Omit it on PATCH to leave the selection unchanged. Null and duplicate IDs are not accepted.","items":{"type":"string"},"maxItems":25,"type":"array","uniqueItems":true},"description":{"type":"string"},"donation_max_amount_money":{"$ref":"#/components/schemas/Money"},"donation_min_amount_money":{"$ref":"#/components/schemas/Money"},"donation_suggested_amount_money_options":{"items":{"$ref":"#/components/schemas/Money"},"type":"array"},"event_config":{"$ref":"#/components/schemas/PaymentLinkEventConfig"},"expiration":{"$ref":"#/components/schemas/CheckoutExpirationConfig"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"image":{"$ref":"#/components/schemas/ImageInput"},"inactive_message":{"type":"string"},"inventory_routing_source":{"$ref":"#/components/schemas/InventoryRoutingSourceInput"},"legal":{"$ref":"#/components/schemas/CheckoutLegalConfig"},"line_items":{"items":{"$ref":"#/components/schemas/PaymentLinkLineItemInput"},"type":"array"},"max_completions":{"format":"int32","type":"integer"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"payment_link_type":{"enum":["standard","donation","event"],"type":"string","x-enum-descriptions":["Standard.","Donation.","Event."],"x-flint-enum":"closed"},"payments":{"$ref":"#/components/schemas/CheckoutPaymentConfig"},"plan_id":{"type":"string"},"promotion_config":{"$ref":"#/components/schemas/CheckoutPromotionConfig"},"redirects":{"$ref":"#/components/schemas/CheckoutRedirectsConfig"},"tax":{"$ref":"#/components/schemas/CheckoutTaxConfig"},"theme":{"$ref":"#/components/schemas/ThemeConfig"},"tip":{"$ref":"#/components/schemas/CheckoutTipConfig"}},"required":["name"],"type":"object"},"CreatePaymentMethodDomainRequest":{"properties":{"domain_name":{"description":"Exact fully-qualified hostname to register. Do not include a scheme, path, port, IP address, or wildcard.","format":"hostname","maxLength":253,"not":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|1?[0-9]{1,2})\\.){3}(?:25[0-5]|2[0-4][0-9]|1?[0-9]{1,2})$"},"pattern":"^(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?\\.)+[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?$","type":"string"}},"required":["domain_name"],"type":"object"},"CreatePayoutRequest":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"balance_source_type":{"enum":["card","bank_account","fpx"],"type":"string","x-enum-descriptions":["Card.","Bank account.","Fpx."],"x-flint-enum":"closed"},"description":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"method":{"enum":["standard"],"type":"string","x-enum-descriptions":["Standard."],"x-flint-enum":"closed"},"payout_destination_id":{"type":"string"},"statement_descriptor":{"type":"string"}},"required":["amount_money"],"type":"object"},"CreatePickupFulfillmentDetails":{"properties":{"address":{"$ref":"#/components/schemas/Address"},"curbside_instructions":{"description":"Instructions specific to curbside handoff.","maxLength":2048,"type":"string"},"customer_arrived_at":{"description":"Buyer-reported arrival time for curbside or counter pickup.","format":"date-time","type":"string"},"expires_at":{"description":"Deadline after which an uncollected pickup should enter merchant review.","format":"date-time","type":"string"},"instructions":{"type":"string"},"location_name":{"type":"string"},"pickup_window_duration_seconds":{"description":"Width of the promised pickup window, from 0 to 86400 seconds.","format":"int64","maximum":86400,"minimum":0,"type":"integer"},"prep_time_duration_seconds":{"description":"Expected preparation time for restaurant and made-to-order pickup, from 0 to 86400 seconds.","format":"int64","maximum":86400,"minimum":0,"type":"integer"},"ready_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"vehicle_description":{"description":"Buyer vehicle description used for curbside handoff.","maxLength":500,"type":"string"},"window_end_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"window_start_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"type":"object"},"CreateProductOptionInput":{"properties":{"client_option_key":{"maxLength":100,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"maxLength":255,"minLength":1,"type":"string"},"position":{"format":"int32","minimum":0,"type":"integer"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"values":{"items":{"$ref":"#/components/schemas/CreateProductOptionValueInput"},"type":"array"}},"required":["name"],"type":"object"},"CreateProductOptionValueInput":{"properties":{"client_value_key":{"maxLength":100,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"position":{"format":"int32","minimum":0,"type":"integer"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"value":{"maxLength":255,"minLength":1,"type":"string"}},"required":["value"],"type":"object"},"CreateProductRequest":{"oneOf":[{"not":{"anyOf":[{"required":["options"]},{"required":["variants"]}]},"required":["default_variant"]},{"not":{"anyOf":[{"required":["default_variant"]}]},"required":["options","variants"]}],"properties":{"categories":{"items":{"maxLength":100,"minLength":1,"type":"string"},"maxItems":100,"type":"array"},"default_variant":{"$ref":"#/components/schemas/ProductVariantInput"},"description":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"images":{"description":"The complete desired gallery in display order. The first image is primary. Send [] to clear the gallery.","items":{"$ref":"#/components/schemas/ImageInput"},"maxItems":8,"minItems":0,"type":"array"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"modifier_set_id":{"description":"Attached modifier set. Send null on update to remove it.","pattern":"^ms_[0-9A-HJKMNP-TV-Z]{26}$","type":["string","null"]},"name":{"type":"string"},"options":{"items":{"$ref":"#/components/schemas/CreateProductOptionInput"},"minItems":1,"type":"array"},"product_type":{"enum":["physical","service","fee","digital"],"type":"string","x-enum-descriptions":["Physical.","Service.","Fee.","Digital."],"x-flint-enum":"closed"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"variants":{"items":{"$ref":"#/components/schemas/ProductVariantInput"},"minItems":1,"type":"array"}},"required":["name","product_type"],"type":"object"},"CreateProductVariantRequest":{"properties":{"variant":{"$ref":"#/components/schemas/ProductVariantInput"}},"required":["variant"],"type":"object"},"CreatePromotionCodeRequest":{"properties":{"code":{"type":"string"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"max_uses":{"format":"int64","type":"integer"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"}},"required":["code"],"type":"object"},"CreatePromotionRequest":{"properties":{"application_method":{"$ref":"#/components/schemas/PromotionApplicationMethod"},"codes":{"description":"Write-only create sugar for code-gated promotions. Accepted only on create; it is not returned on read and cannot be changed via PATCH. Manage codes after create via the /v1/promotions/{promotion_id}/codes child routes.","items":{"$ref":"#/components/schemas/CreatePromotionCodeRequest"},"type":"array","writeOnly":true},"combines_with":{"$ref":"#/components/schemas/PromotionCombinesWith"},"description":{"type":"string"},"discount_class":{"default":"order","description":"Defaults to order when omitted.","enum":["order","line_item","service_charge"],"type":"string","x-enum-descriptions":["Order.","Line item.","Service charge."],"x-flint-enum":"closed"},"display_name":{"description":"Buyer-facing promotion name shown in checkout and order discount surfaces. Defaults to name when omitted.","type":"string"},"eligibility_rules":{"$ref":"#/components/schemas/PromotionRuleGroup"},"exclusivity":{"$ref":"#/components/schemas/PromotionExclusivity"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"max_uses":{"format":"int64","type":"integer"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"description":"Internal promotion name for dashboards, searching, and reporting. This is not intended for buyer-facing checkout or receipt copy.","type":"string"},"redemption_type":{"enum":["automatic","code"],"type":"string","x-enum-descriptions":["Automatic.","Code."],"x-flint-enum":"closed"},"schedule":{"$ref":"#/components/schemas/PromotionSchedule"},"stacking_mode":{"enum":["continue","stop_after"],"type":"string","x-enum-descriptions":["Continue.","Stop after."],"x-flint-enum":"closed"}},"required":["application_method","name"],"type":"object"},"CreateRefundRequest":{"anyOf":[{"required":["order_id"]},{"required":["payment_intent_id"]}],"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"charges":{"items":{"$ref":"#/components/schemas/RefundCharge"},"type":"array"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"line_items":{"items":{"$ref":"#/components/schemas/RefundLineItem"},"type":"array"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"payment_intent_id":{"type":"string"},"reason":{"description":"Optional. When omitted, no reason is recorded or sent to the processor, and the buyer's refund email has no reason line.","enum":["duplicate","fraudulent","requested_by_customer","defective_product","wrong_item_shipped","never_received","not_as_described","arrived_too_late","customer_changed_mind","better_price_found","accidental_order","other"],"type":"string","x-enum-descriptions":["Duplicate.","Fraudulent.","Requested by customer.","Defective product.","Wrong item shipped.","Never received.","Not as described.","Arrived too late.","Customer changed mind.","Better price found.","Accidental order.","Other."],"x-flint-enum":"closed"},"reason_message":{"type":"string"},"refund_method":{"enum":["original_payment"],"type":"string","x-enum-descriptions":["Original payment."],"x-flint-enum":"closed"},"tax_breakdown_refunds":{"items":{"$ref":"#/components/schemas/RefundTaxBreakdownRefundIn"},"type":"array"}},"type":"object"},"CreateReportRequest":{"properties":{"currency":{"description":"Three-letter ISO 4217 currency. Reports never combine currencies.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"},"interval_end_at":{"description":"Exclusive report interval end instant.","format":"date-time","type":"string"},"interval_start_at":{"description":"Inclusive report interval start instant.","format":"date-time","type":"string"},"report_type":{"description":"Choose tax_transactions_itemized_v1 for frozen Quaderno-backed collection and successful refund evidence. This export supports reconciliation and import. It is not a tax return, nexus decision, or filing instruction.","enum":["orders_itemized_v1","payments_itemized_v1","balance_transactions_itemized_v1","payouts_itemized_v1","tax_itemized_v1","tax_summarized_v1","merchant_billing_itemized_v1","tax_transactions_itemized_v1"],"type":"string","x-enum-descriptions":["Orders itemized v1.","Payments itemized v1.","Balance transactions itemized v1.","Payouts itemized v1.","Tax itemized v1.","Tax summarized v1.","Merchant billing itemized v1.","Tax transactions itemized v1."],"x-flint-enum":"closed"},"timezone":{"description":"IANA timezone used for date bucketing. Defaults to UTC.","type":"string"}},"required":["currency","interval_end_at","interval_start_at","report_type"],"type":"object"},"CreateReturnDispositionRequest":{"additionalProperties":false,"oneOf":[{"not":{"required":["return_inspection_line_item_id"]},"required":["return_receipt_line_item_id"]},{"not":{"required":["return_receipt_line_item_id"]},"required":["return_inspection_line_item_id"]}],"properties":{"disposition_type":{"enum":["sellable","quality_control","damaged","quarantined","repair","refurbish","liquidate","donate","discard","return_to_buyer","lost"],"type":"string","x-enum-descriptions":["Sellable.","Quality control.","Damaged.","Quarantined.","Repair.","Refurbish.","Liquidate.","Donate.","Discard.","Return to buyer.","Lost."],"x-flint-enum":"closed"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"inventory_location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"reason":{"enum":["inspection_result","return_policy","warehouse_override","safety_requirement","other"],"type":"string","x-enum-descriptions":["Inspection result.","Return policy.","Warehouse override.","Safety requirement.","Other."],"x-flint-enum":"closed"},"reason_message":{"type":"string"},"replaces_return_disposition_id":{"type":"string"},"return_inspection_line_item_id":{"type":"string"},"return_receipt_line_item_id":{"type":"string"}},"required":["disposition_type","occurred_at","quantity","reason"],"type":"object"},"CreateReturnDispositionResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnDisposition"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CreateReturnEligibilityCheckRequest":{"additionalProperties":false,"properties":{"order_id":{"type":"string"},"selection":{"$ref":"#/components/schemas/ReturnEligibilitySelection"}},"required":["order_id","selection"],"type":"object"},"CreateReturnInspectionRequest":{"additionalProperties":false,"properties":{"correction_reason":{"enum":["entry_error","duplicate_observation","source_correction","reconciliation_correction","other"],"type":"string","x-enum-descriptions":["Entry error.","Duplicate observation.","Source correction.","Reconciliation correction.","Other."],"x-flint-enum":"closed"},"correction_reason_message":{"type":"string"},"external_actor_id":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"inspected_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"line_items":{"items":{"$ref":"#/components/schemas/ReturnInspectionLineItemInput"},"minItems":1,"type":"array"},"location_id":{"type":"string"},"return_receipt_id":{"type":"string"},"source_system":{"$ref":"#/components/schemas/ReturnSourceSystem"},"supersedes_return_inspection_id":{"type":"string"}},"required":["inspected_at","line_items","location_id","return_receipt_id"],"type":"object"},"CreateReturnInspectionResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnInspection"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CreateReturnPolicyRequest":{"additionalProperties":false,"properties":{"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"revision":{"$ref":"#/components/schemas/ReturnPolicyRevisionInput"}},"required":["name","revision"],"type":"object"},"CreateReturnPolicyResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnPolicy"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CreateReturnPreviewData":{"discriminator":{"propertyName":"mode"},"oneOf":[{"not":{"required":["resolution"]},"properties":{"mode":{"enum":["eligibility"],"x-enum-descriptions":["Eligibility."],"x-flint-enum":"closed"}},"required":["mode","eligibility"]},{"not":{"required":["eligibility"]},"properties":{"mode":{"enum":["resolution"],"x-enum-descriptions":["Resolution."],"x-flint-enum":"closed"}},"required":["mode","resolution"]}],"properties":{"eligibility":{"$ref":"#/components/schemas/ReturnEligibilityCheck"},"mode":{"enum":["eligibility","resolution"],"type":"string","x-enum-descriptions":["Eligibility.","Resolution."],"x-flint-enum":"closed"},"resolution":{"$ref":"#/components/schemas/ReturnResolutionPreview"}},"required":["mode"],"type":"object"},"CreateReturnPreviewRequest":{"additionalProperties":false,"discriminator":{"propertyName":"mode"},"oneOf":[{"not":{"required":["resolution"]},"properties":{"mode":{"enum":["eligibility"],"x-enum-descriptions":["Eligibility."],"x-flint-enum":"closed"}},"required":["mode","eligibility"]},{"not":{"required":["eligibility"]},"properties":{"mode":{"enum":["resolution"],"x-enum-descriptions":["Resolution."],"x-flint-enum":"closed"}},"required":["mode","resolution"]}],"properties":{"eligibility":{"$ref":"#/components/schemas/CreateReturnEligibilityCheckRequest"},"mode":{"enum":["eligibility","resolution"],"type":"string","x-enum-descriptions":["Eligibility.","Resolution."],"x-flint-enum":"closed"},"resolution":{"$ref":"#/components/schemas/CreateReturnResolutionPreviewRequest"}},"required":["mode"],"type":"object"},"CreateReturnPreviewResponse":{"properties":{"data":{"$ref":"#/components/schemas/CreateReturnPreviewData"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CreateReturnReasonRequest":{"additionalProperties":false,"properties":{"category_handles":{"items":{"type":"string"},"type":"array"},"description":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"handle":{"type":"string"},"is_note_required":{"default":false,"type":"boolean"},"name":{"type":"string"}},"required":["handle","name"],"type":"object"},"CreateReturnReasonResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnReason"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CreateReturnReceiptRequest":{"additionalProperties":false,"properties":{"correction_reason":{"enum":["entry_error","duplicate_observation","source_correction","reconciliation_correction","other"],"type":"string","x-enum-descriptions":["Entry error.","Duplicate observation.","Source correction.","Reconciliation correction.","Other."],"x-flint-enum":"closed"},"correction_reason_message":{"type":"string"},"external_actor_id":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"line_items":{"items":{"$ref":"#/components/schemas/ReturnReceiptLineItemInput"},"minItems":1,"type":"array"},"received_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"receiving_location_id":{"type":"string"},"shipment_id":{"type":"string"},"source_system":{"$ref":"#/components/schemas/ReturnSourceSystem"},"supersedes_return_receipt_id":{"type":"string"}},"required":["line_items","received_at","receiving_location_id"],"type":"object"},"CreateReturnReceiptResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnReceipt"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CreateReturnRequest":{"additionalProperties":false,"properties":{"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"line_items":{"items":{"$ref":"#/components/schemas/ReturnLineItemInput"},"minItems":1,"type":"array"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"}},"required":["line_items","order_id"],"type":"object"},"CreateReturnResolutionPreviewRequest":{"additionalProperties":false,"discriminator":{"propertyName":"resolution_type"},"oneOf":[{"not":{"required":["corrects_return_resolution_id"]},"properties":{"line_items":{"minItems":1},"resolution_type":{"enum":["refund","exchange","replacement","no_monetary_action"],"x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action."],"x-flint-enum":"closed"}},"required":["line_items"]},{"not":{"anyOf":[{"required":["line_items"]},{"required":["replacement_line_items"]},{"required":["pricing_basis"]}]},"properties":{"adjustments":{"minItems":1},"resolution_type":{"enum":["correction"],"x-enum-descriptions":["Correction."],"x-flint-enum":"closed"}},"required":["corrects_return_resolution_id","adjustments"]}],"properties":{"adjustments":{"items":{"$ref":"#/components/schemas/ReturnResolutionAdjustmentInput"},"type":"array"},"corrects_return_resolution_id":{"type":"string"},"expected_version":{"format":"int64","minimum":0,"type":"integer"},"line_items":{"items":{"$ref":"#/components/schemas/ReturnResolutionLineItemInput"},"type":"array"},"pricing_basis":{"enum":["original_price","current_price","merchant_agreed_price"],"type":"string","x-enum-descriptions":["Original price.","Current price.","Merchant agreed price."],"x-flint-enum":"closed"},"replacement_line_items":{"items":{"$ref":"#/components/schemas/ReturnReplacementLineItemInput"},"type":"array"},"resolution_type":{"enum":["refund","exchange","replacement","no_monetary_action","correction"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action.","Correction."],"x-flint-enum":"closed"},"return_id":{"type":"string"}},"required":["resolution_type","return_id"],"type":"object"},"CreateReturnResolutionRequest":{"additionalProperties":false,"discriminator":{"propertyName":"resolution_type"},"oneOf":[{"not":{"required":["corrects_return_resolution_id"]},"properties":{"line_items":{"minItems":1},"resolution_type":{"enum":["refund","exchange","replacement","no_monetary_action"],"x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action."],"x-flint-enum":"closed"}},"required":["line_items"]},{"not":{"anyOf":[{"required":["line_items"]},{"required":["replacement_line_items"]},{"required":["pricing_basis"]}]},"properties":{"adjustments":{"minItems":1},"resolution_type":{"enum":["correction"],"x-enum-descriptions":["Correction."],"x-flint-enum":"closed"}},"required":["corrects_return_resolution_id","adjustments"]}],"properties":{"adjustments":{"items":{"$ref":"#/components/schemas/ReturnResolutionAdjustmentInput"},"type":"array"},"corrects_return_resolution_id":{"type":"string"},"expected_version":{"format":"int64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"line_items":{"items":{"$ref":"#/components/schemas/ReturnResolutionLineItemInput"},"type":"array"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"pricing_basis":{"enum":["original_price","current_price","merchant_agreed_price"],"type":"string","x-enum-descriptions":["Original price.","Current price.","Merchant agreed price."],"x-flint-enum":"closed"},"replacement_line_items":{"items":{"$ref":"#/components/schemas/ReturnReplacementLineItemInput"},"type":"array"},"resolution_type":{"enum":["refund","exchange","replacement","no_monetary_action","correction"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action.","Correction."],"x-flint-enum":"closed"}},"required":["resolution_type"],"type":"object"},"CreateReturnResolutionResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnResolution"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CreateReturnResponse":{"properties":{"data":{"$ref":"#/components/schemas/Return"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CreateRiskListRequest":{"properties":{"alias":{"pattern":"^[a-z][a-z0-9_]{0,127}$","type":"string"},"item_type":{"enum":["card_fingerprint","card_bin","email","email_domain","ip_address","country","customer_id","string","case_sensitive_string"],"type":"string","x-enum-descriptions":["Card fingerprint.","Card bin.","Email.","Email domain.","Ip address.","Country.","Customer id.","String.","Case sensitive string."],"x-flint-enum":"closed"},"name":{"type":"string"}},"required":["alias","name","item_type"],"type":"object"},"CreateRiskPreviewRequest":{"oneOf":[{"not":{"required":["risk_rule_id"]},"required":["action","predicate"]},{"required":["risk_rule_id"]}],"properties":{"action":{"enum":["allow","block","review","require_3ds"],"type":"string","x-enum-descriptions":["Allow.","Block.","Review.","Require 3ds."],"x-flint-enum":"closed"},"predicate":{"$ref":"#/components/schemas/RiskPredicateNode"},"risk_rule_id":{"type":"string"}},"type":"object"},"CreateRiskRuleRequest":{"properties":{"action":{"enum":["allow","block","review","require_3ds"],"type":"string","x-enum-descriptions":["Allow.","Block.","Review.","Require 3ds."],"x-flint-enum":"closed"},"description":{"type":"string"},"enabled":{"default":true,"type":"boolean"},"predicate":{"$ref":"#/components/schemas/RiskPredicateNode"}},"required":["action","predicate","description"],"type":"object"},"CreateSandboxRequest":{"properties":{"issue_test_key":{"type":"boolean"},"name":{"type":"string"},"scopes":{"items":{"type":"string"},"type":"array"},"test_key_name":{"type":"string"}},"required":["name"],"type":"object"},"CreateServiceFulfillmentDetails":{"properties":{"notes":{"type":"string"},"scheduled_end_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"scheduled_start_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"type":"object"},"CreateShipmentRequest":{"oneOf":[{"not":{"anyOf":[{"required":["return_id"]},{"required":["return_line_items"]}]},"properties":{"direction":{"enum":["outbound"],"type":"string","x-enum-descriptions":["Outbound."],"x-flint-enum":"closed"}},"title":"Outbound shipment"},{"properties":{"direction":{"enum":["return"],"type":"string","x-enum-descriptions":["Return."],"x-flint-enum":"closed"},"return_line_items":{"minItems":1,"type":"array"}},"required":["direction","return_id","return_line_items"],"title":"Return shipment"}],"properties":{"direction":{"enum":["outbound","return"],"type":"string","x-enum-descriptions":["Outbound.","Return."],"x-flint-enum":"closed"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system. Caller-owned shipment identifier in external_system. Set with external_system to enable duplicate detection and replay for that provider reference.","maxLength":255,"minLength":1,"type":"string"},"external_system":{"description":"External carrier, aggregator, or fulfillment platform name for this shipment. Set with external_reference_id to enable duplicate detection and replay for that provider reference; without external_reference_id this is stored as provenance only.","type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"return_id":{"type":"string"},"return_line_items":{"items":{"$ref":"#/components/schemas/ReturnShipmentLineItemAllocation"},"type":"array"}},"type":"object"},"CreateShipmentResponse":{"properties":{"data":{"$ref":"#/components/schemas/CreateShipmentResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CreateShipmentResult":{"properties":{"replayed":{"type":"boolean"},"shipment":{"$ref":"#/components/schemas/Shipment"}},"required":["shipment"],"type":"object"},"CreateSubscriptionPlanRequest":{"properties":{"billing_interval":{"enum":["daily","weekly","monthly","yearly"],"type":"string","x-enum-descriptions":["Daily.","Weekly.","Monthly.","Yearly."],"x-flint-enum":"closed"},"billing_interval_count":{"format":"int32","type":"integer"},"contract_term_months":{"format":"int32","type":"integer"},"currency":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"},"description":{"type":"string"},"early_termination_fee_money":{"$ref":"#/components/schemas/Money"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"images":{"description":"The complete desired gallery in display order. The first image is primary. Send [] to clear the gallery.","items":{"$ref":"#/components/schemas/ImageInput"},"maxItems":8,"minItems":0,"type":"array"},"line_items":{"items":{"$ref":"#/components/schemas/SubscriptionPlanLineItemInput"},"type":"array"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"setup_fee_money":{"$ref":"#/components/schemas/Money"},"trial_period_days":{"format":"int32","type":"integer"}},"required":["billing_interval","billing_interval_count","currency","name"],"type":"object"},"CreateSubscriptionRequest":{"additionalProperties":false,"oneOf":[{"description":"Flint owns the renewal date. billing_anchor_day is allowed only in this branch.","properties":{"billing_schedule":{"additionalProperties":false,"properties":{"owner":{"enum":["flint"],"type":"string","x-enum-descriptions":["Flint."],"x-flint-enum":"closed"}},"required":["owner"],"type":"object"}},"required":["billing_schedule"]},{"description":"The integration owns the renewal date. billing_anchor_day is not allowed.","not":{"required":["billing_anchor_day"]},"properties":{"billing_schedule":{"additionalProperties":false,"properties":{"owner":{"enum":["external"],"type":"string","x-enum-descriptions":["External."],"x-flint-enum":"closed"}},"required":["owner"],"type":"object"}},"required":["billing_schedule"]},{"description":"The merchant default selects the owner. Owner-specific sibling fields are not allowed.","not":{"anyOf":[{"required":["billing_schedule"]},{"required":["billing_anchor_day"]}]}}],"properties":{"billing_anchor_day":{"format":"int32","type":"integer"},"billing_schedule":{"$ref":"#/components/schemas/SubscriptionBillingScheduleInput"},"billing_start":{"$ref":"#/components/schemas/SubscriptionBillingStartInput"},"customer_id":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"payment_method_id":{"type":"string"},"plan_id":{"type":"string"},"service_location":{"$ref":"#/components/schemas/SubscriptionServiceLocationInput"}},"required":["billing_start","customer_id","plan_id"],"type":"object"},"CreateWebhookEndpointRequest":{"properties":{"api_version":{"description":"Set default to follow the merchant default, or a supported YYYY-MM-DD version to pin this endpoint. Omission follows the merchant default. Null is not accepted.","type":"string"},"description":{"type":"string"},"enabled":{"type":"boolean"},"enabled_events":{"description":"Event types this endpoint receives. Empty means all merchant-owned events. For partner_app sources, empty defaults to all app lifecycle events. For installed_merchants sources, provide at least one installed-merchant event.","items":{"type":"string"},"type":"array"},"event_sources":{"description":"Event sources this endpoint receives. Defaults to merchant. Use partner_app for app lifecycle events and installed_merchants for events from merchants that installed the partner app.","items":{"enum":["merchant","partner_app","installed_merchants"],"type":"string","x-enum-descriptions":["Merchant.","Partner app.","Installed merchants."],"x-flint-enum":"closed"},"type":"array"},"mode":{"description":"Partner-source delivery mode. Valid values are test, live, and both. Mode applies to installed_merchants events; partner_app lifecycle events require both.","enum":["test","live","both"],"type":"string","x-enum-descriptions":["Test.","Live.","Both."],"x-flint-enum":"closed"},"partner_app_id":{"description":"Partner app that owns partner_app or installed_merchants event sources.","type":"string"},"url":{"type":"string"}},"required":["url"],"type":"object"},"CreateWebhookTestEventRequest":{"properties":{"event_type":{"enum":["balance.updated","balance_transaction.created","balance_transaction.updated","capability.updated","checkout_session.completed","checkout_session.closed","checkout_session.expired","checkout_session.invalidated","credit_note.allocation_created","credit_note.allocation_reversed","credit_note.created","credit_note.issued","credit_note.updated","credit_note.voided","customer.created","customer.deletion_completed","customer.deletion_rejected","customer.deletion_requested","customer.updated","dispute.closed","dispute.created","dispute.lost","dispute.needs_response","dispute.prevented","dispute.updated","dispute.warning_closed","dispute.won","fraud_warning.created","fraud_warning.updated","delivery_rate_callback.archived","delivery_rate_callback.created","delivery_rate_callback.deactivated","delivery_rate_callback.activated","delivery_rate_callback.updated","delivery_method.archived","delivery_method.created","delivery_method.deactivated","delivery_method.activated","delivery_method.updated","delivery_location_set.archived","delivery_location_set.created","delivery_location_set.deactivated","delivery_location_set.activated","delivery_location_set.updated","delivery_profile.archived","delivery_profile.created","delivery_profile.deactivated","delivery_profile.activated","delivery_profile.updated","delivery_rate.archived","delivery_rate.created","delivery_rate.updated","delivery_revocation.created","delivery_selection.committed","delivery_zone.archived","delivery_zone.created","delivery_zone.deactivated","delivery_zone.activated","delivery_zone.updated","invoice.collection_block_resolved","invoice.collection_blocked","invoice.credited","invoice.created","invoice.delivery_failed","invoice.delivery_succeeded","invoice.issued","invoice.issue_failed","invoice.late_fee_due","invoice.late_fee_assessed","invoice.late_fee_waived","invoice.marked_uncollectible","invoice.manual_payment_recorded","invoice.manual_payment_reversed","invoice.overdue","invoice.paid","invoice.payment_processing","invoice.payment_attempt_canceled","invoice.payment_attempt_expired","invoice.payment_failed","invoice.partially_paid","invoice.partially_refunded","invoice.refunded","invoice.reminder_due","invoice.sent","invoice.updated","invoice.voided","inventory.action_required","inventory.count.applied","inventory.level.updated","inventory.receipt.created","inventory.reservation.at_risk","inventory.reservation.closed","inventory.reservation.committed","inventory.reservation.consumed","inventory.reservation.created","inventory.reservation.hold_expired","inventory.reservation.released","inventory.shortage.detected","inventory.transfer.closed","inventory.transfer.departed","inventory.transfer.lost","inventory.transfer.received","inventory.transfer.returned","merchant_billing_balance.updated","merchant.readiness.updated","merchant_subscription_invoice.issued","merchant_subscription_invoice.updated","order.closed","order.created","order.fulfillment.completed","order.fulfillment.created","order.fulfillment.event.created","order.fulfillment.package.created","order.fulfillment.package.updated","order.fulfillment.shipment.created","order.fulfillment.shipment.updated","order.fulfillment.status_changed","order.fulfillment.updated","order.inventory_action_required","order.inventory_exception.created","order.inventory_exception.resolved","order.payment_authorization_expired","order.payment_authorization_canceled","order.payment_authorized","order.payment_captured","order.partially_paid","order.paid","order.refunded","order.updated","payment_intent.canceled","payment_intent.fulfillment_hold.updated","payment_intent.payment_failed","payment_intent.processing","payment_intent.requires_action","payment_intent.requires_capture","payment_intent.succeeded","payment_method.failed","payment_method.removed","payment_method.saved","payout.canceled","payout.created","payout.failed","payout.paid","payout.reversed","payout.updated","payout_destination.created","payout_destination.deleted","payout_destination.disabled","payout_destination.updated","payout_settings.updated","refund.created","refund.failed","refund.updated","report.failed","report.succeeded","return.canceled","return.completed","return.created","return.decision_recorded","return.reopened","return.updated","return_disposition.created","return_disposition.updated","return_inspection.acceptance_decided","return_inspection.created","return_inspection.superseded","return_receipt.created","return_receipt.superseded","return_receipt.verified","return_resolution.created","return_resolution.updated","review.closed","review.opened","subscription.activated","subscription.canceled","subscription.created","subscription.dunning_exhausted","subscription.past_due","subscription.paused","subscription.payment_failed","subscription.payment_succeeded","subscription.resumed","subscription.renewal_upcoming","subscription.trial_ending","subscription.updated"],"type":"string","x-enum-descriptions":["Balance.updated.","Balance transaction.created.","Balance transaction.updated.","Capability.updated.","Checkout session.completed.","Checkout session.closed.","Checkout session.expired.","Checkout session.invalidated.","Credit note.allocation created.","Credit note.allocation reversed.","Credit note.created.","Credit note.issued.","Credit note.updated.","Credit note.voided.","Customer.created.","Customer.deletion completed.","Customer.deletion rejected.","Customer.deletion requested.","Customer.updated.","Dispute.closed.","Dispute.created.","Dispute.lost.","Dispute.needs response.","Dispute.prevented.","Dispute.updated.","Dispute.warning closed.","Dispute.won.","Fraud warning.created.","Fraud warning.updated.","Delivery rate callback.archived.","Delivery rate callback.created.","Delivery rate callback.deactivated.","Delivery rate callback.activated.","Delivery rate callback.updated.","Delivery method.archived.","Delivery method.created.","Delivery method.deactivated.","Delivery method.activated.","Delivery method.updated.","Delivery location set.archived.","Delivery location set.created.","Delivery location set.deactivated.","Delivery location set.activated.","Delivery location set.updated.","Delivery profile.archived.","Delivery profile.created.","Delivery profile.deactivated.","Delivery profile.activated.","Delivery profile.updated.","Delivery rate.archived.","Delivery rate.created.","Delivery rate.updated.","Delivery revocation.created.","Delivery selection.committed.","Delivery zone.archived.","Delivery zone.created.","Delivery zone.deactivated.","Delivery zone.activated.","Delivery zone.updated.","Invoice.collection block resolved.","Invoice.collection blocked.","Invoice.credited.","Invoice.created.","Invoice.delivery failed.","Invoice.delivery succeeded.","Invoice.issued.","Invoice.issue failed.","Invoice.late fee due.","Invoice.late fee assessed.","Invoice.late fee waived.","Invoice.marked uncollectible.","Invoice.manual payment recorded.","Invoice.manual payment reversed.","Invoice.overdue.","Invoice.paid.","Invoice.payment processing.","Invoice.payment attempt canceled.","Invoice.payment attempt expired.","Invoice.payment failed.","Invoice.partially paid.","Invoice.partially refunded.","Invoice.refunded.","Invoice.reminder due.","Invoice.sent.","Invoice.updated.","Invoice.voided.","Inventory.action required.","Inventory.count.applied.","Inventory.level.updated.","Inventory.receipt.created.","Inventory.reservation.at risk.","Inventory.reservation.closed.","Inventory.reservation.committed.","Inventory.reservation.consumed.","Inventory.reservation.created.","Inventory.reservation.hold expired.","Inventory.reservation.released.","Inventory.shortage.detected.","Inventory.transfer.closed.","Inventory.transfer.departed.","Inventory.transfer.lost.","Inventory.transfer.received.","Inventory.transfer.returned.","Merchant billing balance.updated.","Merchant.readiness.updated.","Merchant subscription invoice.issued.","Merchant subscription invoice.updated.","Order.closed.","Order.created.","Order.fulfillment.completed.","Order.fulfillment.created.","Order.fulfillment.event.created.","Order.fulfillment.package.created.","Order.fulfillment.package.updated.","Order.fulfillment.shipment.created.","Order.fulfillment.shipment.updated.","Order.fulfillment.status changed.","Order.fulfillment.updated.","Order.inventory action required.","Order.inventory exception.created.","Order.inventory exception.resolved.","Order.payment authorization expired.","Order.payment authorization canceled.","Order.payment authorized.","Order.payment captured.","Order.partially paid.","Order.paid.","Order.refunded.","Order.updated.","Payment intent.canceled.","Payment intent.fulfillment hold.updated.","Payment intent.payment failed.","Payment intent.processing.","Payment intent.requires action.","Payment intent.requires capture.","Payment intent.succeeded.","Payment method.failed.","Payment method.removed.","Payment method.saved.","Payout.canceled.","Payout.created.","Payout.failed.","Payout.paid.","Payout.reversed.","Payout.updated.","Payout destination.created.","Payout destination.deleted.","Payout destination.disabled.","Payout destination.updated.","Payout settings.updated.","Refund.created.","Refund.failed.","Refund.updated.","Report.failed.","Report.succeeded.","Return.canceled.","Return.completed.","Return.created.","Return.decision recorded.","Return.reopened.","Return.updated.","Return disposition.created.","Return disposition.updated.","Return inspection.acceptance decided.","Return inspection.created.","Return inspection.superseded.","Return receipt.created.","Return receipt.superseded.","Return receipt.verified.","Return resolution.created.","Return resolution.updated.","Review.closed.","Review.opened.","Subscription.activated.","Subscription.canceled.","Subscription.created.","Subscription.dunning exhausted.","Subscription.past due.","Subscription.paused.","Subscription.payment failed.","Subscription.payment succeeded.","Subscription.resumed.","Subscription.renewal upcoming.","Subscription.trial ending.","Subscription.updated."],"x-flint-enum":"closed"}},"required":["event_type"],"type":"object"},"CreditNote":{"description":"A correction against an issued invoice. Credit notes reduce what is owed; refunds return what was already collected.","properties":{"buyer_tax_identity":{"anyOf":[{"$ref":"#/components/schemas/TaxIdentity"},{"type":"null"}],"description":"Identity frozen on the source invoice at issue. Later profile edits do not change this document.","readOnly":true},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"credit_note_id":{"type":"string"},"credit_note_lines":{"items":{"$ref":"#/components/schemas/CreditNoteLine"},"type":"array"},"credit_note_number":{"description":"Assigned at issue and stable from then on. Absent while the credit note is a draft.","type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"invoice_id":{"type":"string"},"issued_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"latest_refund_status":{"enum":["pending","in_transit","succeeded","failed","requires_action","canceled","partially_succeeded"],"type":"string","x-enum-descriptions":["Pending.","In transit.","Succeeded.","Failed.","Requires action.","Canceled.","Partially succeeded."],"x-flint-enum":"open"},"memo":{"description":"Free text shown on the credit note, up to 4096 characters.","type":"string"},"merchant_id":{"type":"string"},"pending_refund_money":{"$ref":"#/components/schemas/Money"},"reason":{"description":"Why the invoice is being corrected. Shown on the credit note document.","enum":["returned_goods","order_adjustment","billing_error","goodwill","other"],"type":"string","x-enum-descriptions":["Returned goods.","Order adjustment.","Billing error.","Goodwill.","Other."],"x-flint-enum":"closed"},"refunded_money":{"$ref":"#/components/schemas/Money"},"seller_tax_identity":{"anyOf":[{"$ref":"#/components/schemas/TaxIdentity"},{"type":"null"}],"description":"Identity frozen on the source invoice at issue. Later profile edits do not change this document.","readOnly":true},"status":{"description":"draft while the credit note is editable, issued once it is numbered and frozen, void once retired.","enum":["draft","issued","void"],"type":"string","x-enum-descriptions":["Draft.","Issued.","Void."],"x-flint-enum":"open"},"total_money":{"$ref":"#/components/schemas/Money","description":"The face value of the credit note, the sum of its lines."},"unallocated_money":{"$ref":"#/components/schemas/Money","description":"Credit still available to allocate. Equals total_money at issue, falls as credit is applied, and rises again when an allocation is reversed."},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"version":{"description":"Current credit note version. Send this as expected_version when updating the draft.","format":"int64","minimum":1,"readOnly":true,"type":"integer"},"voided_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["created_at","credit_note_id","credit_note_lines","invoice_id","merchant_id","pending_refund_money","reason","refunded_money","status","total_money","unallocated_money","updated_at","version"],"type":"object"},"CreditNoteAllocation":{"description":"One application of credit to the invoice. Allocations are append-only: a reversal sets reversed_at rather than removing the row.","properties":{"allocated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"amount_money":{"$ref":"#/components/schemas/Money","description":"Credit applied to the invoice balance."},"credit_note_allocation_id":{"type":"string"},"credit_note_id":{"type":"string"},"idempotency_key":{"description":"The key the caller sent when allocating. It is this allocation's identity and is filterable on the allocations list.","type":"string"},"invoice_id":{"type":"string"},"reversed_at":{"description":"When the allocation was reversed and its credit returned. Absent while the allocation stands.","format":"date-time","type":"string"}},"required":["allocated_at","amount_money","credit_note_allocation_id","credit_note_id","idempotency_key","invoice_id"],"type":"object"},"CreditNoteAllocationListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CreditNoteAllocation"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CreditNoteAllocationResponse":{"properties":{"data":{"$ref":"#/components/schemas/CreditNoteAllocation"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CreditNoteAllocationResult":{"description":"The allocation, the credit note with its new unallocated_money, and the recomputed invoice.","properties":{"credit_note":{"$ref":"#/components/schemas/CreditNote"},"credit_note_allocation":{"$ref":"#/components/schemas/CreditNoteAllocation"},"invoice":{"$ref":"#/components/schemas/Invoice"}},"required":["credit_note","credit_note_allocation","invoice"],"type":"object"},"CreditNoteAllocationResultResponse":{"properties":{"data":{"$ref":"#/components/schemas/CreditNoteAllocationResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CreditNoteCorrectionRequest":{"oneOf":[{"not":{"required":["amount_money"]},"properties":{"type":{"enum":["quantity"],"type":"string","x-enum-descriptions":["Quantity."],"x-flint-enum":"closed"}},"required":["type","quantity"]},{"not":{"required":["quantity"]},"properties":{"type":{"enum":["amount"],"type":"string","x-enum-descriptions":["Amount."],"x-flint-enum":"closed"}},"required":["type","amount_money"]}],"properties":{"amount_money":{"$ref":"#/components/schemas/Money","description":"Amount to credit, no more than the source invoice line is worth, in the invoice currency."},"quantity":{"description":"Units to credit, no more than the source invoice line carries. Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"type":{"description":"quantity credits whole units and requires quantity. amount credits a named figure and requires amount_money. The two are mutually exclusive.","enum":["quantity","amount"],"type":"string","x-enum-descriptions":["Quantity.","Amount."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"CreditNoteLine":{"description":"One credited invoice line, with the discount and tax share Flint derived from the source line.","properties":{"credit_note_line_id":{"type":"string"},"description":{"type":"string"},"discount_money":{"$ref":"#/components/schemas/Money"},"invoice_line_item_id":{"description":"The invoice snapshot line this corrects.","type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"subtotal_money":{"$ref":"#/components/schemas/Money"},"tax_money":{"$ref":"#/components/schemas/Money"},"total_money":{"$ref":"#/components/schemas/Money","description":"What this line credits, discount and tax included."}},"required":["credit_note_line_id","description","discount_money","invoice_line_item_id","subtotal_money","tax_money","total_money"],"type":"object"},"CreditNoteLineRequest":{"properties":{"correction":{"$ref":"#/components/schemas/CreditNoteCorrectionRequest"},"credit_note_line_id":{"type":"string"},"invoice_line_item_id":{"type":"string"}},"required":["correction","invoice_line_item_id"],"type":"object"},"CreditNoteListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CreditNote"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CreditNoteRefundInput":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"reason":{"enum":["duplicate","fraudulent","requested_by_customer","defective_product","wrong_item_shipped","never_received","not_as_described","arrived_too_late","customer_changed_mind","better_price_found","accidental_order","other"],"type":"string","x-enum-descriptions":["Duplicate.","Fraudulent.","Requested by customer.","Defective product.","Wrong item shipped.","Never received.","Not as described.","Arrived too late.","Customer changed mind.","Better price found.","Accidental order.","Other."],"x-flint-enum":"closed"},"reason_message":{"type":"string"}},"required":["reason"],"type":"object"},"CreditNoteRefundListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Refund"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CreditNoteResponse":{"properties":{"data":{"$ref":"#/components/schemas/CreditNote"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"Customer":{"properties":{"billing_address":{"$ref":"#/components/schemas/Address"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"customer_id":{"readOnly":true,"type":"string"},"default_invoice_payment_term_id":{"readOnly":true,"type":"string"},"default_payment_method":{"anyOf":[{"$ref":"#/components/schemas/ExpandedPaymentMethodSummary"},{"type":"null"}],"readOnly":true},"default_payment_method_id":{"readOnly":true,"type":"string"},"email":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"group_id":{"type":"string"},"internal_note":{"type":"string"},"is_verified":{"type":"boolean"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"phone":{"type":"string"},"receivables":{"$ref":"#/components/schemas/CustomerReceivables","readOnly":true},"shipping_address":{"$ref":"#/components/schemas/Address"},"tax_exempt":{"type":"boolean"},"tax_identity":{"anyOf":[{"$ref":"#/components/schemas/TaxIdentity"},{"type":"null"}]},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"version":{"format":"uint64","minimum":1,"readOnly":true,"type":"integer"}},"required":["customer_id","email","version"],"type":"object"},"CustomerAccountDNSRecord":{"properties":{"dns_record_type":{"enum":["cname","txt"],"type":"string","x-enum-descriptions":["Cname.","Txt."],"x-flint-enum":"closed"},"name":{"type":"string"},"value":{"type":"string"}},"required":["dns_record_type","name","value"],"type":"object"},"CustomerAccountDomainStatus":{"properties":{"dns_records":{"items":{"$ref":"#/components/schemas/CustomerAccountDNSRecord"},"type":"array"},"domain_status":{"enum":["provisioning","active","attention_required"],"type":"string","x-enum-descriptions":["Provisioning.","Active.","Attention required."],"x-flint-enum":"open"},"hostname":{"type":"string"},"last_checked_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["dns_records","domain_status","hostname","last_checked_at"],"type":"object"},"CustomerAccountPresentation":{"properties":{"account_name":{"type":"string"},"custom_domain":{"type":"string"},"is_flint_branding_hidden":{"type":"boolean"}},"type":"object"},"CustomerAccountRouteTemplates":{"properties":{"order":{"type":"string"},"return":{"type":"string"},"subscription":{"type":"string"}},"type":"object"},"CustomerAccountSettings":{"properties":{"merchant_account_url":{"type":"string"},"mode":{"enum":["flint_hosted","merchant_hosted"],"type":"string","x-enum-descriptions":["Flint hosted.","Merchant hosted."],"x-flint-enum":"closed"},"presentation":{"$ref":"#/components/schemas/CustomerAccountPresentation"},"route_templates":{"$ref":"#/components/schemas/CustomerAccountRouteTemplates"}},"type":"object"},"CustomerAddress":{"properties":{"address":{"$ref":"#/components/schemas/PostalAddress"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"customer_address_id":{"type":"string"},"customer_id":{"type":"string"},"is_default_billing":{"type":"boolean"},"is_default_shipping":{"type":"boolean"},"label":{"type":"string"},"phone":{"type":"string"},"recipient_name":{"type":"string"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["address","created_at","customer_address_id","customer_id","is_default_billing","is_default_shipping","recipient_name","updated_at"],"type":"object"},"CustomerAddressListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CustomerAddress"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CustomerAddressResponse":{"properties":{"data":{"$ref":"#/components/schemas/CustomerAddress"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CustomerDeletionRequest":{"properties":{"customer_deletion_request_id":{"type":"string"},"customer_id":{"type":"string"},"requested_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"resolved_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"retention_policy":{"type":"string"},"status":{"enum":["pending_review","processing","completed","rejected","failed"],"type":"string","x-enum-descriptions":["Pending review.","Processing.","Completed.","Rejected.","Failed."],"x-flint-enum":"open"}},"required":["customer_deletion_request_id","customer_id","requested_at","retention_policy","status"],"type":"object"},"CustomerDeletionRequestListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CustomerDeletionRequest"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CustomerDeletionRequestResponse":{"properties":{"data":{"$ref":"#/components/schemas/CustomerDeletionRequest"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CustomerEmailDeliverySettings":{"properties":{"dunning":{"enum":["flint_sends","merchant_sends"],"type":"string","x-enum-descriptions":["Flint sends.","Merchant sends."],"x-flint-enum":"closed"},"fulfillment_updates":{"enum":["flint_sends","merchant_sends"],"type":"string","x-enum-descriptions":["Flint sends.","Merchant sends."],"x-flint-enum":"closed"},"invoices":{"enum":["flint_sends","merchant_sends"],"type":"string","x-enum-descriptions":["Flint sends.","Merchant sends."],"x-flint-enum":"closed"},"order_receipts":{"enum":["flint_sends","merchant_sends"],"type":"string","x-enum-descriptions":["Flint sends.","Merchant sends."],"x-flint-enum":"closed"},"returns":{"enum":["flint_sends","merchant_sends"],"type":"string","x-enum-descriptions":["Flint sends.","Merchant sends."],"x-flint-enum":"closed"},"subscription_lifecycle":{"enum":["flint_sends","merchant_sends"],"type":"string","x-enum-descriptions":["Flint sends.","Merchant sends."],"x-flint-enum":"closed"}},"type":"object"},"CustomerListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Customer"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CustomerReceivableBalance":{"properties":{"currency":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"},"outstanding_money":{"$ref":"#/components/schemas/Money"},"overdue_money":{"$ref":"#/components/schemas/Money"}},"required":["currency","outstanding_money","overdue_money"],"type":"object"},"CustomerReceivables":{"properties":{"balances":{"items":{"$ref":"#/components/schemas/CustomerReceivableBalance"},"type":"array"},"observed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["balances","observed_at"],"type":"object"},"CustomerResponse":{"properties":{"data":{"$ref":"#/components/schemas/Customer"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CustomerSession":{"properties":{"account_url":{"readOnly":true,"type":"string"},"account_url_expires_at":{"description":"RFC3339 expiration instant.","format":"date-time","readOnly":true,"type":["string","null"]},"customer_id":{"readOnly":true,"type":"string"},"customer_session_id":{"readOnly":true,"type":"string"},"expires_at":{"description":"RFC3339 expiration instant.","format":"date-time","readOnly":true,"type":"string"},"refresh_token":{"readOnly":true,"type":"string"},"refresh_token_expires_at":{"description":"RFC3339 expiration instant.","format":"date-time","readOnly":true,"type":"string"},"secret":{"readOnly":true,"type":"string"}},"required":["customer_id","customer_session_id","expires_at","refresh_token","refresh_token_expires_at","secret"],"type":"object"},"CustomerSessionResponse":{"properties":{"data":{"$ref":"#/components/schemas/CustomerSession"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CustomerSessionRevocation":{"properties":{"customer_session_id":{"type":"string"},"revoked":{"type":"boolean"}},"required":["customer_session_id","revoked"],"type":"object"},"CustomerSessionRevocationResponse":{"properties":{"data":{"$ref":"#/components/schemas/CustomerSessionRevocation"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"CustomerSessionsRevocation":{"properties":{"customer_id":{"type":"string"},"revoked_count":{"format":"int64","type":"integer"}},"required":["customer_id","revoked_count"],"type":"object"},"CustomerSessionsRevocationResponse":{"properties":{"data":{"$ref":"#/components/schemas/CustomerSessionsRevocation"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DecideReturnInspectionLineItemRequest":{"additionalProperties":false,"properties":{"acceptance_decision_reason":{"enum":["inspection_result","return_policy","manual_review","other"],"type":"string","x-enum-descriptions":["Inspection result.","Return policy.","Manual review.","Other."],"x-flint-enum":"closed"},"acceptance_decision_reason_message":{"type":"string"},"acceptance_status":{"enum":["accepted","rejected","review_required"],"type":"string","x-enum-descriptions":["Accepted.","Rejected.","Review required."],"x-flint-enum":"open"},"expected_version":{"format":"int64","minimum":1,"type":"integer"}},"required":["acceptance_decision_reason","acceptance_status"],"type":"object"},"DecideReturnInspectionLineItemResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnInspection"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DecideReturnRequest":{"additionalProperties":false,"properties":{"completion_mode":{"description":"Omit to use the completion mode established by all matched return policies. Required when the policies disagree or do not establish a mode.","enum":["manual","automatic"],"type":"string","x-enum-descriptions":["Manual.","Automatic."],"x-flint-enum":"closed"},"expected_version":{"format":"int64","minimum":1,"type":"integer"},"line_items":{"items":{"$ref":"#/components/schemas/ReturnLineDecision"},"minItems":1,"type":"array"}},"required":["line_items"],"type":"object"},"DecideReturnResponse":{"properties":{"data":{"$ref":"#/components/schemas/Return"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeclineReviewRequest":{"properties":{"add_to_block_list":{"default":false,"type":"boolean"}},"type":"object"},"DeletePayoutDestinationRequest":{"properties":{},"type":"object"},"DeleteReturnLineItemResponse":{"properties":{"data":{"$ref":"#/components/schemas/Return"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeleteReturnPolicyResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnPolicy"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeleteReturnReasonResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnReason"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeliveryAddressAdvisoryResource":{"properties":{"role":{"enum":["destination_address","buyer_location"],"type":"string","x-enum-descriptions":["Destination address.","Buyer location."],"x-flint-enum":"closed"},"suggested_address":{"$ref":"#/components/schemas/DeliveryAddressInput"},"verification_state":{"enum":["needs_review","unverifiable"],"type":"string","x-enum-descriptions":["Needs review.","Unverifiable."],"x-flint-enum":"closed"}},"required":["role","verification_state"],"type":"object"},"DeliveryAddressInput":{"additionalProperties":false,"properties":{"city":{"type":"string"},"country":{"description":"ISO 3166-1 alpha-2 country code.","example":"US","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"line1":{"type":"string"},"line2":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}},"type":"object"},"DeliveryAddressResource":{"properties":{"city":{"type":"string"},"country":{"description":"ISO 3166-1 alpha-2 country code.","example":"US","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"line1":{"type":"string"},"line2":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}},"type":"object"},"DeliveryArrivalEstimate":{"additionalProperties":false,"properties":{"earliest_date":{"description":"Calendar date in the option timezone. Do not parse it as a UTC timestamp.","format":"date","type":"string"},"latest_date":{"description":"Calendar date in the option timezone. Do not parse it as a UTC timestamp.","format":"date","type":"string"},"timezone":{"type":"string"}},"required":["earliest_date","latest_date","timezone"],"type":"object"},"DeliveryAvailability":{"properties":{"blackout_intervals":{"items":{"$ref":"#/components/schemas/DeliveryBlackoutInterval"},"type":"array"},"dst_disambiguation":{"default":"earlier","enum":["earlier","later"],"type":"string","x-enum-descriptions":["Earlier.","Later."],"x-flint-enum":"closed"},"maximum_scheduling_horizon_days":{"type":"integer"},"preparation_lead_time_seconds":{"format":"int64","type":"integer"},"same_day_cutoff_minute":{"type":"integer"},"timezone":{"type":"string"},"weekly_intervals":{"items":{"$ref":"#/components/schemas/DeliveryWeeklyInterval"},"type":"array"}},"required":["maximum_scheduling_horizon_days","preparation_lead_time_seconds","timezone","weekly_intervals"],"type":"object"},"DeliveryBlackoutInterval":{"properties":{"end_local":{"type":"string"},"start_local":{"type":"string"}},"required":["end_local","start_local"],"type":"object"},"DeliveryBusinessDayRange":{"properties":{"maximum":{"type":"integer"},"minimum":{"type":"integer"}},"required":["maximum","minimum"],"type":"object"},"DeliveryBuyerLocationInput":{"discriminator":{"propertyName":"type"},"oneOf":[{"not":{"required":["coordinate"]},"properties":{"type":{"const":"address"}},"required":["type","address"]},{"not":{"required":["address"]},"properties":{"type":{"const":"coordinate"}},"required":["type","coordinate"]}],"properties":{"address":{"$ref":"#/components/schemas/DeliveryAddressInput"},"coordinate":{"$ref":"#/components/schemas/DeliveryCoordinateInput"},"type":{"enum":["address","coordinate"],"type":"string","x-enum-descriptions":["Address.","Coordinate."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"DeliveryBuyerLocationResource":{"description":"The normalized buyer address or coordinate used for this quote.","discriminator":{"propertyName":"type"},"oneOf":[{"not":{"required":["coordinate"]},"properties":{"type":{"const":"address"}},"required":["type","address"]},{"not":{"required":["address"]},"properties":{"type":{"const":"coordinate"}},"required":["type","coordinate"]}],"properties":{"address":{"$ref":"#/components/schemas/DeliveryAddressResource"},"coordinate":{"$ref":"#/components/schemas/DeliveryCoordinateInput"},"type":{"enum":["address","coordinate"],"type":"string","x-enum-descriptions":["Address.","Coordinate."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"DeliveryCalculatedPricingStrategy":{"additionalProperties":false,"properties":{"base_fee":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"distance":{"$ref":"#/components/schemas/DeliveryDistanceUnitPrice"},"maximum_amount":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"minimum_amount":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"per_item_handling":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"weight":{"$ref":"#/components/schemas/DeliveryWeightUnitPrice"}},"type":"object"},"DeliveryCalculatedPricingStrategyInput":{"additionalProperties":false,"properties":{"base_fee":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"distance":{"$ref":"#/components/schemas/DeliveryDistanceUnitPriceInput"},"maximum_amount":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"minimum_amount":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"per_item_handling":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"weight":{"$ref":"#/components/schemas/DeliveryWeightUnitPriceInput"}},"type":"object"},"DeliveryCallbackPricingStrategyInput":{"additionalProperties":false,"properties":{"delivery_rate_callback_id":{"type":"string"},"maximum_amount":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"minimum_amount":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"preview_enabled":{"type":"boolean"}},"required":["delivery_rate_callback_id"],"type":"object"},"DeliveryCallerSuppliedPricingStrategyInput":{"additionalProperties":false,"properties":{"maximum_amount":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"minimum_amount":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"}},"required":["maximum_amount","minimum_amount"],"type":"object"},"DeliveryCandidateOutcomeResource":{"discriminator":{"propertyName":"type"},"oneOf":[{"properties":{"type":{"enum":["available"],"type":"string","x-enum-descriptions":["Available."],"x-flint-enum":"closed"}},"required":["type","option"]},{"properties":{"type":{"enum":["unavailable"],"type":"string","x-enum-descriptions":["Unavailable."],"x-flint-enum":"closed"}},"required":["type","unavailable_reason"]},{"properties":{"type":{"enum":["input_required"],"type":"string","x-enum-descriptions":["Input required."],"x-flint-enum":"closed"}},"required":["type","input_requirements"]},{"properties":{"type":{"enum":["cannot_calculate"],"type":"string","x-enum-descriptions":["Cannot calculate."],"x-flint-enum":"closed"}},"required":["type","failure_category","retryable"]},{"properties":{"type":{"enum":["requires_checkout_context"],"type":"string","x-enum-descriptions":["Requires checkout context."],"x-flint-enum":"closed"}},"required":["type"]},{"properties":{"type":{"enum":["unsupported_in_preview"],"type":"string","x-enum-descriptions":["Unsupported in preview."],"x-flint-enum":"closed"}},"required":["type"]}],"properties":{"address_advisories":{"items":{"$ref":"#/components/schemas/DeliveryAddressAdvisoryResource"},"type":"array"},"failure_category":{"description":"Why Flint could not calculate the method and the action that can make calculation succeed.\n- `dependency_failure`: Retry after the dependent service recovers.\n- `timeout`: Retry after the timed-out dependency recovers.\n- `malformed_response`: Fix the callback response so it matches the documented response schema, then retry.\n- `callback_transport_failure`: Restore callback DNS, TLS, network connectivity, and response timing, then retry.\n- `callback_circuit_open`: Restore the callback and wait for circuit recovery before retrying.\n- `callback_result_invalid`: Fix the callback result fields or values identified by the callback logs, then retry.\n- `callback_unavailable`: Restore the configured callback endpoint or choose a non-callback pricing strategy.\n- `pricing_failure`: Fix the method pricing configuration or matching rate, then retry.\n- `schedule_failure`: Fix the method schedule, timezone, or requested window, then retry.\n- `option_lifetime_too_short`: Increase the method minimum option lifetime or return a later callback expiry.\n- `geography_failure`: Fix the destination, origin, or geographic configuration, then retry.\n- `routing_failure`: Fix inventory routing or origin assignment, then retry.\n- `invalid_configuration`: Correct the invalid delivery configuration identified by diagnostics, then retry.\n- `invalid_buyer_input`: Correct the buyer input identified by the outcome, then retry.\n- `address_verification_failed`: Correct the address fields rejected by verification, then retry.\n- `address_could_not_be_verified`: Confirm or correct the address, or retry when address verification is available.","enum":["dependency_failure","timeout","malformed_response","callback_transport_failure","callback_circuit_open","callback_result_invalid","callback_unavailable","pricing_failure","schedule_failure","option_lifetime_too_short","geography_failure","routing_failure","invalid_configuration","invalid_buyer_input","address_verification_failed","address_could_not_be_verified"],"type":"string","x-enum-descriptions":["Dependency failure.","Timeout.","Malformed response.","Callback transport failure.","Callback circuit open.","Callback result invalid.","Callback unavailable.","Pricing failure.","Schedule failure.","Option lifetime too short.","Geography failure.","Routing failure.","Invalid configuration.","Invalid buyer input.","Address verification failed.","Address could not be verified."],"x-flint-enum":"closed","x-flint-enum-descriptions":{"address_could_not_be_verified":"Confirm or correct the address, or retry when address verification is available.","address_verification_failed":"Correct the address fields rejected by verification, then retry.","callback_circuit_open":"Restore the callback and wait for circuit recovery before retrying.","callback_result_invalid":"Fix the callback result fields or values identified by the callback logs, then retry.","callback_transport_failure":"Restore callback DNS, TLS, network connectivity, and response timing, then retry.","callback_unavailable":"Restore the configured callback endpoint or choose a non-callback pricing strategy.","dependency_failure":"Retry after the dependent service recovers.","geography_failure":"Fix the destination, origin, or geographic configuration, then retry.","invalid_buyer_input":"Correct the buyer input identified by the outcome, then retry.","invalid_configuration":"Correct the invalid delivery configuration identified by diagnostics, then retry.","malformed_response":"Fix the callback response so it matches the documented response schema, then retry.","option_lifetime_too_short":"Increase the method minimum option lifetime or return a later callback expiry.","pricing_failure":"Fix the method pricing configuration or matching rate, then retry.","routing_failure":"Fix inventory routing or origin assignment, then retry.","schedule_failure":"Fix the method schedule, timezone, or requested window, then retry.","timeout":"Retry after the timed-out dependency recovers."}},"input_requirements":{"items":{"$ref":"#/components/schemas/DeliveryInputRequirement"},"type":"array"},"option":{"$ref":"#/components/schemas/DeliveryOptionProjection"},"retryable":{"type":"boolean"},"type":{"enum":["available","unavailable","input_required","cannot_calculate","requires_checkout_context","unsupported_in_preview"],"type":"string","x-enum-descriptions":["Available.","Unavailable.","Input required.","Cannot calculate.","Requires checkout context.","Unsupported in preview."],"x-flint-enum":"closed"},"unavailable_reason":{"description":"Why the method is unavailable and the action that can make it eligible.\n- `destination_not_served`: Use a destination covered by this method or choose another method.\n- `pickup_unavailable`: Choose an available pickup method or location.\n- `no_window_available`: Choose another offered window or a method with availability for the requested time.\n- `eligibility_no_match`: Inspect eligibility_mismatches, then change the relevant buyer facts or method eligibility rule.\n- `method_type_not_allowed`: Choose a method type allowed by every line item in the choice group.\n- `pricing_unavailable`: Add or activate a matching rate, or provide the required caller-supplied price.\n- `inventory_unavailable`: Choose an origin or method backed by available inventory.","enum":["destination_not_served","pickup_unavailable","no_window_available","eligibility_no_match","method_type_not_allowed","pricing_unavailable","inventory_unavailable"],"type":"string","x-enum-descriptions":["Destination not served.","Pickup unavailable.","No window available.","Eligibility no match.","Method type not allowed.","Pricing unavailable.","Inventory unavailable."],"x-flint-enum":"closed","x-flint-enum-descriptions":{"destination_not_served":"Use a destination covered by this method or choose another method.","eligibility_no_match":"Inspect eligibility_mismatches, then change the relevant buyer facts or method eligibility rule.","inventory_unavailable":"Choose an origin or method backed by available inventory.","method_type_not_allowed":"Choose a method type allowed by every line item in the choice group.","no_window_available":"Choose another offered window or a method with availability for the requested time.","pickup_unavailable":"Choose an available pickup method or location.","pricing_unavailable":"Add or activate a matching rate, or provide the required caller-supplied price."}}},"required":["type"],"type":"object"},"DeliveryCoordinateInput":{"additionalProperties":false,"properties":{"latitude":{"maximum":90,"minimum":-90,"type":"number"},"longitude":{"maximum":180,"minimum":-180,"type":"number"}},"required":["latitude","longitude"],"type":"object"},"DeliveryCountryCondition":{"additionalProperties":false,"properties":{"subject":{"default":"destination_address","description":"Address facts tested by this condition. destination_address is the shipping destination. buyer_location is the buyer's current pickup or local-delivery location.","enum":["destination_address","buyer_location"],"type":"string","x-enum-descriptions":["Destination address.","Buyer location."],"x-flint-enum":"closed"},"values":{"items":{"type":"string"},"type":"array"}},"required":["values"],"type":"object"},"DeliveryCustomerBooleanCondition":{"additionalProperties":false,"properties":{"value":{"type":"boolean"}},"required":["value"],"type":"object"},"DeliveryCustomerGroupCondition":{"additionalProperties":false,"properties":{"values":{"items":{"type":"string"},"type":"array"}},"required":["values"],"type":"object"},"DeliveryDistance":{"additionalProperties":false,"properties":{"unit":{"enum":["meter","kilometer","mile"],"type":"string","x-enum-descriptions":["Meter.","Kilometer.","Mile."],"x-flint-enum":"closed"},"value":{"type":"number"}},"required":["unit","value"],"type":"object"},"DeliveryDistanceUnitPrice":{"additionalProperties":false,"properties":{"currency_options":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"unit":{"description":"Distance unit used by unit_quantity.","enum":["meter","kilometer","mile"],"type":"string","x-enum-descriptions":["Meter.","Kilometer.","Mile."],"x-flint-enum":"closed"},"unit_quantity":{"description":"Whole-number quantity of the selected unit charged at each configured currency price; fractional quantities are not supported.","format":"int64","minimum":1,"type":"integer"}},"required":["currency_options","unit","unit_quantity"],"type":"object"},"DeliveryDistanceUnitPriceInput":{"additionalProperties":false,"properties":{"currency_options":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"unit":{"description":"Distance unit used by unit_quantity.","enum":["meter","kilometer","mile"],"type":"string","x-enum-descriptions":["Meter.","Kilometer.","Mile."],"x-flint-enum":"closed"},"unit_quantity":{"description":"Whole-number quantity of the selected unit charged at each configured currency price; fractional quantities are not supported.","format":"int64","minimum":1,"type":"integer"}},"required":["currency_options","unit","unit_quantity"],"type":"object"},"DeliveryEligibilityExpression":{"additionalProperties":false,"description":"A boolean expression containing exactly one operator or typed condition at each node. Expressions support at most 8 levels and 100 total nodes.","oneOf":[{"required":["all"]},{"required":["any"]},{"required":["not"]},{"required":["zone"]},{"required":["country"]},{"required":["state"]},{"required":["postal_code"]},{"required":["radius"]},{"required":["window_time"]},{"required":["customer_group"]},{"required":["customer_verified"]},{"required":["customer_has_email"]},{"required":["customer_has_phone_number"]}],"properties":{"all":{"items":{"$ref":"#/components/schemas/DeliveryEligibilityExpression"},"maxItems":100,"minItems":1,"type":"array"},"any":{"items":{"$ref":"#/components/schemas/DeliveryEligibilityExpression"},"maxItems":100,"minItems":1,"type":"array"},"country":{"$ref":"#/components/schemas/DeliveryCountryCondition"},"customer_group":{"$ref":"#/components/schemas/DeliveryCustomerGroupCondition"},"customer_has_email":{"$ref":"#/components/schemas/DeliveryCustomerBooleanCondition"},"customer_has_phone_number":{"$ref":"#/components/schemas/DeliveryCustomerBooleanCondition"},"customer_verified":{"$ref":"#/components/schemas/DeliveryCustomerBooleanCondition"},"not":{"$ref":"#/components/schemas/DeliveryEligibilityExpression"},"postal_code":{"$ref":"#/components/schemas/DeliveryPostalCodeCondition"},"radius":{"$ref":"#/components/schemas/DeliveryRadiusCondition"},"state":{"$ref":"#/components/schemas/DeliveryStateCondition"},"window_time":{"$ref":"#/components/schemas/DeliveryWindowTimeCondition"},"zone":{"$ref":"#/components/schemas/DeliveryZoneCondition"}},"type":"object"},"DeliveryEligibilityMismatch":{"additionalProperties":false,"properties":{"condition":{"description":"The configured eligibility condition family that did not match.","enum":["zone","country","state","postal_code","radius","window_time","customer_group","customer_verified","customer_has_email","customer_has_phone_number"],"type":"string","x-enum-descriptions":["Zone.","Country.","State.","Postal code.","Radius.","Window time.","Customer group.","Customer verified.","Customer has email.","Customer has phone number."],"x-flint-enum":"closed"},"expression_path":{"description":"The condition's path in the configured eligibility expression, starting at $.","type":"string"},"field":{"description":"The eligibility fact evaluated by the condition. Buyer fact values are not included.","type":"string"},"negated":{"description":"Whether the condition matched inside a not expression and therefore rejected the method.","type":"boolean"}},"required":["condition","expression_path"],"type":"object"},"DeliveryEstimateRule":{"properties":{"schedule_window":{"$ref":"#/components/schemas/DeliveryScheduleWindowRule"},"transit_time":{"$ref":"#/components/schemas/DeliveryTransitTimeRule"},"type":{"enum":["none","transit_time","schedule_window"],"type":"string","x-enum-descriptions":["None.","Transit time.","Schedule window."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"DeliveryEstimateRuleInput":{"additionalProperties":false,"properties":{"schedule_window":{"$ref":"#/components/schemas/DeliveryScheduleWindowRuleInput"},"transit_time":{"$ref":"#/components/schemas/DeliveryTransitTimeRule"},"type":{"enum":["none","transit_time","schedule_window"],"type":"string","x-enum-descriptions":["None.","Transit time.","Schedule window."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"DeliveryExternalPricingStrategy":{"additionalProperties":false,"properties":{"delivery_rate_callback_id":{"type":"string"},"delivery_rate_callback_revision_id":{"type":"string"},"maximum_amount":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"minimum_amount":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"preview_enabled":{"type":"boolean"}},"required":["maximum_amount","minimum_amount"],"type":"object"},"DeliveryFixedPricingStrategy":{"additionalProperties":false,"properties":{"currency_options":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"}},"required":["currency_options"],"type":"object"},"DeliveryFixedPricingStrategyInput":{"additionalProperties":false,"properties":{"currency_options":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"}},"required":["currency_options"],"type":"object"},"DeliveryFulfillmentDetails":{"properties":{"carrier":{"type":"string"},"courier_pickup_at":{"description":"Time at which the courier collected the order.","format":"date-time","type":"string"},"courier_pickup_window_duration_seconds":{"description":"Width of the promised courier pickup window, from 0 to 86400 seconds.","format":"int64","maximum":86400,"minimum":0,"type":"integer"},"courier_provider_name":{"description":"Delivery network or merchant fleet provider handling the job.","maxLength":255,"type":"string"},"courier_support_phone_number":{"description":"Buyer-safe support number for the courier or merchant fleet.","maxLength":30,"type":"string"},"delivered_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"dispatched_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"dropoff_notes":{"description":"Driver-facing notes for the final handoff.","maxLength":2048,"type":"string"},"expires_at":{"description":"Deadline after which an undelivered job should enter merchant review.","format":"date-time","type":"string"},"external_delivery_id":{"description":"Stable delivery job ID owned by the courier or merchant dispatch system.","maxLength":255,"type":"string"},"instructions":{"type":"string"},"no_contact":{"description":"Whether the buyer requested a no-contact handoff.","type":"boolean"},"prep_time_duration_seconds":{"description":"Expected preparation time before courier pickup, from 0 to 86400 seconds.","format":"int64","maximum":86400,"minimum":0,"type":"integer"},"ready_at":{"description":"Time at which the order became ready for courier pickup.","format":"date-time","type":"string"},"service_area_id":{"type":"string"},"tracking_url":{"description":"Absolute HTTPS carrier tracking URL. Embedded URL credentials are rejected.","type":"string"},"window_end_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"window_start_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"type":"object"},"DeliveryInputConstraint":{"additionalProperties":false,"properties":{"allowed_values":{"items":{"type":"string"},"type":"array"},"earliest_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"format":{"type":"string"},"latest_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"maximum_length":{"format":"int32","type":"integer"},"minimum_length":{"format":"int32","type":"integer"},"offered_windows":{"items":{"$ref":"#/components/schemas/DeliveryWindowResource"},"type":"array"},"supported_countries":{"items":{"type":"string"},"type":"array"},"type":{"enum":["string","address_field","email","phone","time_window","coordinate","caller_supplied_rate"],"type":"string","x-enum-descriptions":["String.","Address field.","Email.","Phone.","Time window.","Coordinate.","Caller supplied rate."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"DeliveryInputRequirement":{"additionalProperties":false,"properties":{"constraint":{"$ref":"#/components/schemas/DeliveryInputConstraint"},"delivery_choice_group_ids":{"items":{"type":"string"},"type":"array"},"delivery_input_requirement_id":{"type":"string"},"delivery_method_ids":{"items":{"type":"string"},"type":"array"},"delivery_option_ids":{"items":{"type":"string"},"type":"array"},"field_path":{"enum":["destination_address","destination_address.line1","destination_address.line2","destination_address.city","destination_address.country","destination_address.state","destination_address.postal_code","buyer_location","buyer_location.line1","buyer_location.line2","buyer_location.city","buyer_location.country","buyer_location.state","buyer_location.postal_code","buyer_location.coordinate","recipient.name","recipient.email","recipient.phone","choices[].input.delivery_window_id","caller_supplied_rates"],"type":"string","x-enum-descriptions":["Destination address.","Destination address.line1.","Destination address.line2.","Destination address.city.","Destination address.country.","Destination address.state.","Destination address.postal code.","Buyer location.","Buyer location.line1.","Buyer location.line2.","Buyer location.city.","Buyer location.country.","Buyer location.state.","Buyer location.postal code.","Buyer location.coordinate.","Recipient.name.","Recipient.email.","Recipient.phone.","Choices[].input.delivery window id.","Caller supplied rates."],"x-flint-enum":"closed"},"purpose":{"enum":["quote","selection","pickup_availability"],"type":"string","x-enum-descriptions":["Quote.","Selection.","Pickup availability."],"x-flint-enum":"closed"}},"required":["constraint","delivery_input_requirement_id","field_path","purpose"],"type":"object"},"DeliveryInventoryAssignmentRequest":{"properties":{"demand_key":{"type":"string"},"inventory_item_id":{"type":"string"},"location_id":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"}},"required":["demand_key","inventory_item_id","location_id","quantity"],"type":"object"},"DeliveryInventoryReservationSummary":{"properties":{"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"inventory_reservation_id":{"type":"string"},"owner_type":{"enum":["delivery_selection","payment_attempt","order_balance_hold"],"type":"string","x-enum-descriptions":["Delivery selection.","Payment attempt.","Order balance hold."],"x-flint-enum":"closed"},"required_next_action":{"enum":["none","retry_payment","replace_selection","contact_merchant"],"type":"string","x-enum-descriptions":["None.","Retry payment.","Replace selection.","Contact merchant."],"x-flint-enum":"closed"},"status":{"enum":["active","closed"],"type":"string","x-enum-descriptions":["Active.","Closed."],"x-flint-enum":"open"}},"required":["expires_at","inventory_reservation_id","owner_type","status"],"type":"object"},"DeliveryLocalDeliveryDetails":{"properties":{"instructions":{"type":"string"},"service_level":{"type":"string"}},"type":"object"},"DeliveryLocationSet":{"additionalProperties":false,"properties":{"configuration":{"$ref":"#/components/schemas/DeliveryLocationSetConfiguration","description":"Current member Locations and selection rules."},"created_at":{"description":"Time the location set was created.","format":"date-time","type":"string"},"current_delivery_location_set_revision_id":{"description":"Immutable revision used for new quotes.","type":"string"},"delivery_location_set_id":{"description":"Stable delivery location set ID.","type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"description":"Caller-owned metadata.","type":"object"},"name":{"description":"Merchant-facing location set name.","type":"string"},"status":{"description":"Current location set lifecycle status.","enum":["inactive","active","archived","revoked"],"type":"string","x-enum-descriptions":["Inactive.","Active.","Archived.","Revoked."],"x-flint-enum":"open"},"updated_at":{"description":"Time the location set last changed.","format":"date-time","type":"string"},"version":{"description":"Optimistic-concurrency version for location set writes.","format":"uint64","minimum":1,"type":"integer"}},"required":["delivery_location_set_id","current_delivery_location_set_revision_id","name","status","version","configuration","created_at","updated_at"],"type":"object"},"DeliveryLocationSetConfiguration":{"additionalProperties":false,"properties":{"location_ids":{"items":{"type":"string"},"type":"array"}},"required":["location_ids"],"type":"object"},"DeliveryLocationSetListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DeliveryLocationSet"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeliveryLocationSetResponse":{"properties":{"data":{"$ref":"#/components/schemas/DeliveryLocationSet"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeliveryLocationSummaryResource":{"properties":{"address":{"$ref":"#/components/schemas/DeliveryAddressResource"},"instructions":{"type":"string"},"location_id":{"type":"string"},"name":{"type":"string"},"timezone":{"type":"string"}},"required":["location_id","name"],"type":"object"},"DeliveryMerchantDiagnostic":{"properties":{"code":{"description":"Stable reason the method did not produce an option.\n- `ELIGIBILITY_NO_MATCH`: The configured eligibility expression excluded the method.\n- `METHOD_UNAVAILABLE`: The method was unavailable for this evaluation.\n- `INPUT_REQUIRED`: More typed buyer or caller input is required.\n- `CHECKOUT_CONTEXT_REQUIRED`: Exact evaluation requires a checkout session.\n- `PREVIEW_UNSUPPORTED`: The method cannot be evaluated in an orderless preview.\n- `DEPENDENCY_FAILURE`: A dependency prevented Flint from proving availability.","enum":["ELIGIBILITY_NO_MATCH","METHOD_UNAVAILABLE","INPUT_REQUIRED","CHECKOUT_CONTEXT_REQUIRED","PREVIEW_UNSUPPORTED","DEPENDENCY_FAILURE"],"type":"string","x-enum-descriptions":["ELIGIBILITY NO MATCH.","METHOD UNAVAILABLE.","INPUT REQUIRED.","CHECKOUT CONTEXT REQUIRED.","PREVIEW UNSUPPORTED.","DEPENDENCY FAILURE."],"x-flint-enum":"closed","x-flint-enum-descriptions":{"CHECKOUT_CONTEXT_REQUIRED":"Exact evaluation requires a checkout session.","DEPENDENCY_FAILURE":"A dependency prevented Flint from proving availability.","ELIGIBILITY_NO_MATCH":"The configured eligibility expression excluded the method.","INPUT_REQUIRED":"More typed buyer or caller input is required.","METHOD_UNAVAILABLE":"The method was unavailable for this evaluation.","PREVIEW_UNSUPPORTED":"The method cannot be evaluated in an orderless preview."}},"delivery_method_id":{"type":"string"},"delivery_method_revision_id":{"type":"string"},"diagnostic_id":{"type":"string"},"eligibility_mismatches":{"description":"Configured eligibility predicates that conclusively rejected the method. Present only for eligibility_no_match.","items":{"$ref":"#/components/schemas/DeliveryEligibilityMismatch"},"type":"array"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"outcome":{"enum":["unavailable","input_required","cannot_calculate","requires_checkout_context","unsupported_in_preview"],"type":"string","x-enum-descriptions":["Unavailable.","Input required.","Cannot calculate.","Requires checkout context.","Unsupported in preview."],"x-flint-enum":"closed"},"recommended_action":{"enum":["review_configuration","provide_input","create_checkout","retry"],"type":"string","x-enum-descriptions":["Review configuration.","Provide input.","Create checkout.","Retry."],"x-flint-enum":"closed"},"retryable":{"type":"boolean"},"scope":{"enum":["method"],"type":"string","x-enum-descriptions":["Method."],"x-flint-enum":"closed"},"summary":{"type":"string"}},"required":["code","diagnostic_id","occurred_at","outcome","recommended_action","retryable","scope","summary"],"type":"object"},"DeliveryMethod":{"additionalProperties":false,"properties":{"configuration":{"$ref":"#/components/schemas/DeliveryMethodConfiguration","description":"Current eligibility, pricing, origin, estimate, and tax configuration."},"created_at":{"description":"Time the method was created.","format":"date-time","type":"string"},"current_delivery_method_revision_id":{"description":"Immutable revision currently used for new quotes.","type":"string"},"delivery_method_id":{"description":"Stable delivery method ID.","type":"string"},"description":{"description":"Optional buyer-facing description.","type":"string"},"display_position":{"description":"Ascending display order among methods.","format":"int32","type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"description":"Caller-owned metadata.","type":"object"},"name":{"description":"Merchant-facing method name.","type":"string"},"recommendation_priority":{"description":"Higher values win recommendation tie-breaks.","format":"int32","type":"integer"},"status":{"description":"Current method lifecycle status.","enum":["inactive","active","archived","revoked"],"type":"string","x-enum-descriptions":["Inactive.","Active.","Archived.","Revoked."],"x-flint-enum":"open"},"type":{"description":"Delivery mode this method offers.","enum":["shipment","local_delivery","pickup"],"type":"string","x-enum-descriptions":["Shipment.","Local delivery.","Pickup."],"x-flint-enum":"closed"},"updated_at":{"description":"Time the method last changed.","format":"date-time","type":"string"},"version":{"description":"Optimistic-concurrency version for method writes.","format":"uint64","minimum":1,"type":"integer"}},"required":["delivery_method_id","current_delivery_method_revision_id","name","status","version","configuration","created_at","updated_at"],"type":"object"},"DeliveryMethodConfiguration":{"additionalProperties":false,"properties":{"buyer_instructions":{"$ref":"#/components/schemas/BuyerInstructionsConfig","description":"Controls whether checkout collects buyer instructions for this method."},"charge_tax_category":{"description":"Charge classification used in tax records and reporting. Omit it to derive shipping for shipment methods, delivery for local delivery, or service_fee for pickup. It does not currently change the automatic rate.","enum":["service_fee","shipping","delivery","handling","surcharge"],"type":"string","x-enum-descriptions":["Service fee.","Shipping.","Delivery.","Handling.","Surcharge."],"x-flint-enum":"closed"},"eligibility":{"$ref":"#/components/schemas/DeliveryEligibilityExpression","description":"Conditions that decide where this method is offered. Omit this field to offer the method everywhere the merchant serves."},"estimate":{"$ref":"#/components/schemas/DeliveryEstimateRule","description":"The buyer-visible delivery or pickup estimate. Use type none when the merchant makes no timing promise."},"minimum_option_lifetime_seconds":{"description":"Minimum remaining quote lifetime required before Flint offers this method. Required for calculated, callback, and caller_supplied pricing; defaults to 0 for other pricing. Must be less than Flint's 15-minute quote lifetime.","format":"int64","maximum":899,"minimum":0,"type":"integer"},"offer_windows":{"description":"Whether buyers choose from enumerated schedule windows. Flint derives this value for new writes and returns it for stored-revision compatibility.","type":"boolean"},"origin":{"$ref":"#/components/schemas/DeliveryMethodOriginSelector","description":"Where delivery starts. A method can use a fixed location or a delivery location set; origin.type determines allocation or buyer pickup behavior."},"pricing":{"$ref":"#/components/schemas/DeliveryPricingStrategy","description":"How Flint calculates the delivery charge."},"public_details":{"additionalProperties":false,"description":"Buyer-visible structured details supplied by the merchant.","properties":{"instructions":{"description":"Buyer-visible instructions for this method.","maxLength":2048,"type":"string"},"pickup_mode":{"description":"Required for pickup methods and rejected for other method types.","enum":["in_store","curbside","locker","other"],"type":"string","x-enum-descriptions":["In store.","Curbside.","Locker.","Other."],"x-flint-enum":"closed"},"service_level":{"description":"Buyer-visible service level. Shipment accepts economy, standard, expedited, express, overnight, same_day. Local delivery accepts on_demand, same_day, scheduled.","enum":["economy","standard","expedited","express","overnight","same_day","on_demand","scheduled"],"type":"string","x-enum-descriptions":["Economy.","Standard.","Expedited.","Express.","Overnight.","Same day.","On demand.","Scheduled."],"x-flint-enum":"closed"}},"type":"object"},"quote_input_fields":{"description":"Address and coordinate fields a callback method requires and is allowed to receive.","items":{"enum":["destination_address","destination_address.line1","destination_address.line2","destination_address.city","destination_address.state","destination_address.postal_code","destination_address.country","buyer_location","buyer_location.line1","buyer_location.line2","buyer_location.city","buyer_location.state","buyer_location.postal_code","buyer_location.country","buyer_location.coordinate"],"type":"string","x-enum-descriptions":["Destination address.","Destination address.line1.","Destination address.line2.","Destination address.city.","Destination address.state.","Destination address.postal code.","Destination address.country.","Buyer location.","Buyer location.line1.","Buyer location.line2.","Buyer location.city.","Buyer location.state.","Buyer location.postal code.","Buyer location.country.","Buyer location.coordinate."],"x-flint-enum":"closed"},"maxItems":12,"type":"array","uniqueItems":true},"recipient_requirements":{"description":"Buyer contact fields required when selecting this method.","items":{"$ref":"#/components/schemas/DeliveryRecipientRequirement"},"type":"array"},"selection_guarantee_seconds":{"description":"How long Flint guarantees a selected price beyond its quote expiry. Defaults to 0, which uses the option expiry.","format":"int64","minimum":0,"type":"integer"},"taxable":{"description":"Whether the delivery charge is taxable. Omit or send null to inherit tax.default_delivery_taxable from effective merchant settings.","type":["boolean","null"]}},"required":["estimate","minimum_option_lifetime_seconds","offer_windows","origin","pricing","selection_guarantee_seconds","charge_tax_category"],"type":"object"},"DeliveryMethodConfigurationCreateInput":{"additionalProperties":false,"oneOf":[{"properties":{"pricing":{"allOf":[{"$ref":"#/components/schemas/DeliveryPricingStrategyCreateInput"},{"properties":{"type":{"enum":["fixed","rate_table","tiered"],"x-enum-descriptions":["Fixed.","Rate table.","Tiered."],"x-flint-enum":"closed"}}}]}}},{"properties":{"pricing":{"allOf":[{"$ref":"#/components/schemas/DeliveryPricingStrategyCreateInput"},{"properties":{"type":{"enum":["calculated"],"x-enum-descriptions":["Calculated."],"x-flint-enum":"closed"}}}]}},"required":["minimum_option_lifetime_seconds"]},{"properties":{"estimate":{"allOf":[{"$ref":"#/components/schemas/DeliveryEstimateRuleInput"},{"properties":{"type":{"enum":["transit_time","schedule_window"],"x-enum-descriptions":["Transit time.","Schedule window."],"x-flint-enum":"closed"}}}]},"pricing":{"allOf":[{"$ref":"#/components/schemas/DeliveryPricingStrategyCreateInput"},{"properties":{"type":{"enum":["callback","caller_supplied"],"x-enum-descriptions":["Callback.","Caller supplied."],"x-flint-enum":"closed"}}}]}},"required":["minimum_option_lifetime_seconds"]}],"properties":{"buyer_instructions":{"$ref":"#/components/schemas/BuyerInstructionsConfig","description":"Controls whether checkout collects buyer instructions for this method."},"charge_tax_category":{"description":"Charge classification used in tax records and reporting. Omit it to derive shipping for shipment methods, delivery for local delivery, or service_fee for pickup. It does not currently change the automatic rate.","enum":["service_fee","shipping","delivery","handling","surcharge",null],"type":["string","null"],"x-enum-descriptions":["Service fee.","Shipping.","Delivery.","Handling.","Surcharge.","Null."],"x-flint-enum":"closed"},"eligibility":{"$ref":"#/components/schemas/DeliveryEligibilityExpression","description":"Conditions that decide where this method is offered. Omit this field to offer the method everywhere the merchant serves."},"estimate":{"$ref":"#/components/schemas/DeliveryEstimateRuleInput","description":"The buyer-visible delivery or pickup estimate. Use type none when the merchant makes no timing promise."},"minimum_option_lifetime_seconds":{"description":"Minimum remaining quote lifetime required before Flint offers this method. Required for calculated, callback, and caller_supplied pricing; defaults to 0 for other pricing. Must be less than Flint's 15-minute quote lifetime.","format":"int64","maximum":899,"minimum":0,"type":"integer"},"origin":{"$ref":"#/components/schemas/DeliveryMethodOriginSelectorInput","description":"Where delivery starts. A method can use a fixed location or a delivery location set; origin.type determines allocation or buyer pickup behavior."},"pricing":{"$ref":"#/components/schemas/DeliveryPricingStrategyCreateInput"},"public_details":{"additionalProperties":false,"description":"Buyer-visible structured details supplied by the merchant.","properties":{"instructions":{"description":"Buyer-visible instructions for this method.","maxLength":2048,"type":"string"},"pickup_mode":{"description":"Required for pickup methods and rejected for other method types.","enum":["in_store","curbside","locker","other"],"type":"string","x-enum-descriptions":["In store.","Curbside.","Locker.","Other."],"x-flint-enum":"closed"},"service_level":{"description":"Buyer-visible service level. Shipment accepts economy, standard, expedited, express, overnight, same_day. Local delivery accepts on_demand, same_day, scheduled.","enum":["economy","standard","expedited","express","overnight","same_day","on_demand","scheduled"],"type":"string","x-enum-descriptions":["Economy.","Standard.","Expedited.","Express.","Overnight.","Same day.","On demand.","Scheduled."],"x-flint-enum":"closed"}},"type":"object"},"quote_input_fields":{"description":"Address and coordinate fields a callback method requires and is allowed to receive.","items":{"enum":["destination_address","destination_address.line1","destination_address.line2","destination_address.city","destination_address.state","destination_address.postal_code","destination_address.country","buyer_location","buyer_location.line1","buyer_location.line2","buyer_location.city","buyer_location.state","buyer_location.postal_code","buyer_location.country","buyer_location.coordinate"],"type":"string","x-enum-descriptions":["Destination address.","Destination address.line1.","Destination address.line2.","Destination address.city.","Destination address.state.","Destination address.postal code.","Destination address.country.","Buyer location.","Buyer location.line1.","Buyer location.line2.","Buyer location.city.","Buyer location.state.","Buyer location.postal code.","Buyer location.country.","Buyer location.coordinate."],"x-flint-enum":"closed"},"maxItems":12,"type":"array","uniqueItems":true},"recipient_requirements":{"description":"Buyer contact fields required when selecting this method.","items":{"$ref":"#/components/schemas/DeliveryRecipientRequirement"},"type":"array"},"selection_guarantee_seconds":{"description":"How long Flint guarantees a selected price beyond its quote expiry. Defaults to 0, which uses the option expiry.","format":"int64","minimum":0,"type":"integer"},"taxable":{"description":"Whether the delivery charge is taxable. Omit or send null to inherit tax.default_delivery_taxable from effective merchant settings.","type":["boolean","null"]}},"required":["origin","pricing"],"type":"object"},"DeliveryMethodConfigurationInput":{"additionalProperties":false,"oneOf":[{"properties":{"pricing":{"allOf":[{"$ref":"#/components/schemas/DeliveryPricingStrategyInput"},{"properties":{"type":{"enum":["fixed","rate_table","tiered"],"x-enum-descriptions":["Fixed.","Rate table.","Tiered."],"x-flint-enum":"closed"}}}]}}},{"properties":{"pricing":{"allOf":[{"$ref":"#/components/schemas/DeliveryPricingStrategyInput"},{"properties":{"type":{"enum":["calculated"],"x-enum-descriptions":["Calculated."],"x-flint-enum":"closed"}}}]}},"required":["minimum_option_lifetime_seconds"]},{"properties":{"estimate":{"allOf":[{"$ref":"#/components/schemas/DeliveryEstimateRuleInput"},{"properties":{"type":{"enum":["transit_time","schedule_window"],"x-enum-descriptions":["Transit time.","Schedule window."],"x-flint-enum":"closed"}}}]},"pricing":{"allOf":[{"$ref":"#/components/schemas/DeliveryPricingStrategyInput"},{"properties":{"type":{"enum":["callback","caller_supplied"],"x-enum-descriptions":["Callback.","Caller supplied."],"x-flint-enum":"closed"}}}]}},"required":["minimum_option_lifetime_seconds"]}],"properties":{"buyer_instructions":{"$ref":"#/components/schemas/BuyerInstructionsConfig","description":"Controls whether checkout collects buyer instructions for this method."},"charge_tax_category":{"description":"Charge classification used in tax records and reporting. Omit it to derive shipping for shipment methods, delivery for local delivery, or service_fee for pickup. It does not currently change the automatic rate.","enum":["service_fee","shipping","delivery","handling","surcharge",null],"type":["string","null"],"x-enum-descriptions":["Service fee.","Shipping.","Delivery.","Handling.","Surcharge.","Null."],"x-flint-enum":"closed"},"eligibility":{"$ref":"#/components/schemas/DeliveryEligibilityExpression","description":"Conditions that decide where this method is offered. Omit this field to offer the method everywhere the merchant serves."},"estimate":{"$ref":"#/components/schemas/DeliveryEstimateRuleInput","description":"The buyer-visible delivery or pickup estimate. Use type none when the merchant makes no timing promise."},"minimum_option_lifetime_seconds":{"description":"Minimum remaining quote lifetime required before Flint offers this method. Required for calculated, callback, and caller_supplied pricing; defaults to 0 for other pricing. Must be less than Flint's 15-minute quote lifetime.","format":"int64","maximum":899,"minimum":0,"type":"integer"},"origin":{"$ref":"#/components/schemas/DeliveryMethodOriginSelectorInput","description":"Where delivery starts. A method can use a fixed location or a delivery location set; origin.type determines allocation or buyer pickup behavior."},"pricing":{"$ref":"#/components/schemas/DeliveryPricingStrategyInput","description":"How Flint calculates the delivery charge."},"public_details":{"additionalProperties":false,"description":"Buyer-visible structured details supplied by the merchant.","properties":{"instructions":{"description":"Buyer-visible instructions for this method.","maxLength":2048,"type":"string"},"pickup_mode":{"description":"Required for pickup methods and rejected for other method types.","enum":["in_store","curbside","locker","other"],"type":"string","x-enum-descriptions":["In store.","Curbside.","Locker.","Other."],"x-flint-enum":"closed"},"service_level":{"description":"Buyer-visible service level. Shipment accepts economy, standard, expedited, express, overnight, same_day. Local delivery accepts on_demand, same_day, scheduled.","enum":["economy","standard","expedited","express","overnight","same_day","on_demand","scheduled"],"type":"string","x-enum-descriptions":["Economy.","Standard.","Expedited.","Express.","Overnight.","Same day.","On demand.","Scheduled."],"x-flint-enum":"closed"}},"type":"object"},"quote_input_fields":{"description":"Address and coordinate fields a callback method requires and is allowed to receive.","items":{"enum":["destination_address","destination_address.line1","destination_address.line2","destination_address.city","destination_address.state","destination_address.postal_code","destination_address.country","buyer_location","buyer_location.line1","buyer_location.line2","buyer_location.city","buyer_location.state","buyer_location.postal_code","buyer_location.country","buyer_location.coordinate"],"type":"string","x-enum-descriptions":["Destination address.","Destination address.line1.","Destination address.line2.","Destination address.city.","Destination address.state.","Destination address.postal code.","Destination address.country.","Buyer location.","Buyer location.line1.","Buyer location.line2.","Buyer location.city.","Buyer location.state.","Buyer location.postal code.","Buyer location.country.","Buyer location.coordinate."],"x-flint-enum":"closed"},"maxItems":12,"type":"array","uniqueItems":true},"recipient_requirements":{"description":"Buyer contact fields required when selecting this method.","items":{"$ref":"#/components/schemas/DeliveryRecipientRequirement"},"type":"array"},"selection_guarantee_seconds":{"description":"How long Flint guarantees a selected price beyond its quote expiry. Defaults to 0, which uses the option expiry.","format":"int64","minimum":0,"type":"integer"},"taxable":{"description":"Whether the delivery charge is taxable. Omit or send null to inherit tax.default_delivery_taxable from effective merchant settings.","type":["boolean","null"]}},"required":["origin","pricing"],"type":"object"},"DeliveryMethodListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DeliveryMethod"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeliveryMethodOriginSelector":{"additionalProperties":false,"discriminator":{"propertyName":"type"},"oneOf":[{"not":{"anyOf":[{"required":["delivery_location_set_id"]},{"required":["delivery_location_set_revision_id"]},{"required":["location_ids"]}]},"properties":{"type":{"const":"fixed_location"}},"required":["type","location_id"]},{"anyOf":[{"required":["delivery_location_set_id"]},{"required":["location_ids"]}],"not":{"required":["location_id"]},"properties":{"location_ids":{"items":{"type":"string"},"maxItems":25,"minItems":1,"type":"array","uniqueItems":true},"type":{"const":"allocated_origin_group"}},"required":["type"]},{"anyOf":[{"required":["delivery_location_set_id"]},{"required":["location_ids"]}],"not":{"required":["location_id"]},"properties":{"location_ids":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array","uniqueItems":true},"type":{"const":"pickup_location_collection"}},"required":["type"]}],"properties":{"delivery_location_set_id":{"type":"string"},"delivery_location_set_revision_id":{"type":"string"},"location_id":{"type":"string"},"location_ids":{"items":{"type":"string"},"type":"array"},"type":{"enum":["fixed_location","allocated_origin_group","pickup_location_collection"],"type":"string","x-enum-descriptions":["Fixed location.","Allocated origin group.","Pickup location collection."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"DeliveryMethodOriginSelectorInput":{"additionalProperties":false,"discriminator":{"propertyName":"type"},"oneOf":[{"not":{"anyOf":[{"required":["delivery_location_set_id"]},{"required":["delivery_location_set_revision_id"]},{"required":["location_ids"]}]},"properties":{"type":{"const":"fixed_location"}},"required":["type","location_id"]},{"not":{"required":["location_id"]},"oneOf":[{"required":["delivery_location_set_id"]},{"required":["location_ids"]}],"properties":{"location_ids":{"items":{"type":"string"},"maxItems":25,"minItems":1,"type":"array","uniqueItems":true},"type":{"const":"allocated_origin_group"}},"required":["type"]},{"not":{"required":["location_id"]},"oneOf":[{"required":["delivery_location_set_id"]},{"required":["location_ids"]}],"properties":{"location_ids":{"items":{"type":"string"},"maxItems":1000,"minItems":1,"type":"array","uniqueItems":true},"type":{"const":"pickup_location_collection"}},"required":["type"]}],"properties":{"delivery_location_set_id":{"description":"Named delivery location set to reuse. Send either delivery_location_set_id or inline location_ids, never both. The set may contain at most 25 Locations for allocated_origin_group or 1,000 for pickup_location_collection.","type":"string"},"location_id":{"type":"string"},"location_ids":{"description":"Inline Location IDs for a set managed by this delivery method. Send either location_ids or delivery_location_set_id, never both. Use 1 to 25 unique Locations for allocated_origin_group or 1 to 1,000 for pickup_location_collection. Reads return these Location IDs without exposing the managed set.","items":{"type":"string"},"type":"array"},"type":{"enum":["fixed_location","allocated_origin_group","pickup_location_collection"],"type":"string","x-enum-descriptions":["Fixed location.","Allocated origin group.","Pickup location collection."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"DeliveryMethodResponse":{"properties":{"data":{"$ref":"#/components/schemas/DeliveryMethod"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeliveryOptionProjection":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"arrival_estimate":{"$ref":"#/components/schemas/DeliveryArrivalEstimate"},"buyer_instructions":{"$ref":"#/components/schemas/BuyerInstructionsConfig"},"charge_tax_category":{"description":"Flint charge tax category.","enum":["service_fee","shipping","delivery","handling","surcharge"],"type":"string","x-enum-descriptions":["Service fee.","Shipping.","Delivery.","Handling.","Surcharge."],"x-flint-enum":"closed"},"consumed_by_delivery_selection_id":{"type":"string"},"delivery_method_id":{"type":"string"},"delivery_method_revision_id":{"type":"string"},"delivery_option_id":{"type":"string"},"delivery_plan":{"$ref":"#/components/schemas/DeliveryPlan"},"description":{"type":"string"},"display_position":{"format":"int32","type":"integer"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"local_delivery":{"$ref":"#/components/schemas/DeliveryLocalDeliveryDetails"},"name":{"type":"string"},"offered_windows":{"items":{"$ref":"#/components/schemas/DeliveryWindowResource"},"type":"array"},"pickup":{"$ref":"#/components/schemas/DeliveryPickupDetails"},"recipient_requirements":{"items":{"$ref":"#/components/schemas/DeliveryRecipientRequirement"},"type":"array"},"recommended":{"type":"boolean"},"shipment":{"$ref":"#/components/schemas/DeliveryShipmentDetails"},"taxable":{"type":"boolean"},"timezone":{"description":"IANA timezone for displaying this option's offered windows.","example":"America/New_York","type":"string"},"type":{"enum":["shipment","pickup","local_delivery"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery."],"x-flint-enum":"closed"},"window_end_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"window_pricing":{"enum":["uniform","varies"],"type":"string","x-enum-descriptions":["Uniform.","Varies."],"x-flint-enum":"closed"},"window_selection":{"enum":["none","offered"],"type":"string","x-enum-descriptions":["None.","Offered."],"x-flint-enum":"closed"},"window_start_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["amount_money","buyer_instructions","delivery_method_id","delivery_plan","display_position","name","recommended","taxable","type","window_selection"],"type":"object"},"DeliveryPendingCallerRateRequest":{"additionalProperties":false,"properties":{"delivery_choice_group_id":{"type":"string"},"delivery_method_id":{"type":"string"},"delivery_method_revision_id":{"type":"string"}},"required":["delivery_choice_group_id","delivery_method_id","delivery_method_revision_id"],"type":"object"},"DeliveryPickupAvailability":{"properties":{"audience":{"enum":["buyer","merchant"],"type":"string","x-enum-descriptions":["Buyer.","Merchant."],"x-flint-enum":"closed"},"evaluated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"evaluation_status":{"enum":["complete","incomplete","degraded"],"type":"string","x-enum-descriptions":["Complete.","Incomplete.","Degraded."],"x-flint-enum":"open"},"input_requirements":{"items":{"$ref":"#/components/schemas/DeliveryInputRequirement"},"type":"array"},"locations":{"items":{"$ref":"#/components/schemas/DeliveryPickupAvailabilityLocationResource"},"type":"array"},"merchant_diagnostics":{"description":"Configured Location exclusions. Present only for merchant-authenticated requests.","items":{"$ref":"#/components/schemas/DeliveryPickupAvailabilityDiagnostic"},"type":"array"}},"required":["audience","evaluated_at","evaluation_status","input_requirements","locations"],"type":"object"},"DeliveryPickupAvailabilityCandidateOutcome":{"properties":{"address_advisories":{"items":{"$ref":"#/components/schemas/DeliveryAddressAdvisoryResource"},"type":"array"},"failure_category":{"description":"Why Flint could not calculate pickup availability and the action that can make calculation succeed.\n- `eligibility_context_invalid`: Refresh the checkout eligibility context, then create a new quote.\n- `eligibility_dependency_failure`: Retry after the eligibility dependency recovers.\n- `pickup_method_unavailable`: Activate or choose an available pickup method.\n- `inventory_dependency_failure`: Retry after inventory availability and routing recover.","enum":["eligibility_context_invalid","eligibility_dependency_failure","pickup_method_unavailable","inventory_dependency_failure"],"type":"string","x-enum-descriptions":["Eligibility context invalid.","Eligibility dependency failure.","Pickup method unavailable.","Inventory dependency failure."],"x-flint-enum":"closed","x-flint-enum-descriptions":{"eligibility_context_invalid":"Refresh the checkout eligibility context, then create a new quote.","eligibility_dependency_failure":"Retry after the eligibility dependency recovers.","inventory_dependency_failure":"Retry after inventory availability and routing recover.","pickup_method_unavailable":"Activate or choose an available pickup method."}},"input_requirements":{"items":{"$ref":"#/components/schemas/DeliveryInputRequirement"},"type":"array"},"retryable":{"type":"boolean"},"type":{"enum":["available","unavailable","input_required","cannot_calculate"],"type":"string","x-enum-descriptions":["Available.","Unavailable.","Input required.","Cannot calculate."],"x-flint-enum":"closed"},"unavailable_reason":{"description":"Why pickup is unavailable and the action that can make it eligible.\n- `eligibility_no_match`: Inspect eligibility_mismatches, then change the relevant buyer facts or method eligibility rule.\n- `inventory_insufficient`: Reduce the requested quantity, replenish inventory, or choose another pickup location.","enum":["eligibility_no_match","inventory_insufficient"],"type":"string","x-enum-descriptions":["Eligibility no match.","Inventory insufficient."],"x-flint-enum":"closed","x-flint-enum-descriptions":{"eligibility_no_match":"Inspect eligibility_mismatches, then change the relevant buyer facts or method eligibility rule.","inventory_insufficient":"Reduce the requested quantity, replenish inventory, or choose another pickup location."}}},"required":["type"],"type":"object"},"DeliveryPickupAvailabilityDiagnostic":{"properties":{"code":{"description":"Stable reason a configured pickup location was excluded.\n- `PICKUP_LOCATION_INACTIVE`: The Location is inactive.\n- `PICKUP_LOCATION_GEOGRAPHY_UNAVAILABLE`: The Location has no usable published geography.\n- `PICKUP_LOCATION_INVENTORY_UNAVAILABLE`: The Location cannot allocate inventory.\n- `PICKUP_LOCATION_DEPENDENCY_FAILURE`: Flint could not resolve the configured Location.","enum":["PICKUP_LOCATION_INACTIVE","PICKUP_LOCATION_GEOGRAPHY_UNAVAILABLE","PICKUP_LOCATION_INVENTORY_UNAVAILABLE","PICKUP_LOCATION_DEPENDENCY_FAILURE"],"type":"string","x-enum-descriptions":["PICKUP LOCATION INACTIVE.","PICKUP LOCATION GEOGRAPHY UNAVAILABLE.","PICKUP LOCATION INVENTORY UNAVAILABLE.","PICKUP LOCATION DEPENDENCY FAILURE."],"x-flint-enum":"closed","x-flint-enum-descriptions":{"PICKUP_LOCATION_DEPENDENCY_FAILURE":"Flint could not resolve the configured Location.","PICKUP_LOCATION_GEOGRAPHY_UNAVAILABLE":"The Location has no usable published geography.","PICKUP_LOCATION_INACTIVE":"The Location is inactive.","PICKUP_LOCATION_INVENTORY_UNAVAILABLE":"The Location cannot allocate inventory."}},"diagnostic_id":{"type":"string"},"location_id":{"type":"string"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"outcome":{"enum":["unavailable","cannot_calculate"],"type":"string","x-enum-descriptions":["Unavailable.","Cannot calculate."],"x-flint-enum":"closed"},"recommended_action":{"enum":["review_configuration","retry"],"type":"string","x-enum-descriptions":["Review configuration.","Retry."],"x-flint-enum":"closed"},"retryable":{"type":"boolean"},"scope":{"enum":["location"],"type":"string","x-enum-descriptions":["Location."],"x-flint-enum":"closed"},"summary":{"type":"string"}},"required":["code","diagnostic_id","location_id","occurred_at","outcome","recommended_action","retryable","scope","summary"],"type":"object"},"DeliveryPickupAvailabilityLocationResource":{"properties":{"applicable_quantities":{"items":{"$ref":"#/components/schemas/DeliveryPickupAvailabilityQuantityResource"},"type":"array"},"candidate_outcome":{"$ref":"#/components/schemas/DeliveryPickupAvailabilityCandidateOutcome"},"compatible_methods":{"items":{"$ref":"#/components/schemas/DeliveryPickupAvailabilityMethodResource"},"type":"array"},"distance_meters":{"type":"number"},"location":{"$ref":"#/components/schemas/DeliveryPickupAvailabilityLocationSummary"}},"required":["applicable_quantities","candidate_outcome","compatible_methods","location"],"type":"object"},"DeliveryPickupAvailabilityLocationSummary":{"properties":{"address":{"$ref":"#/components/schemas/DeliveryAddressResource"},"location_id":{"type":"string"},"name":{"type":"string"}},"required":["location_id","name"],"type":"object"},"DeliveryPickupAvailabilityMaximumDistanceRequest":{"properties":{"unit":{"enum":["meters","kilometers","miles"],"type":"string","x-enum-descriptions":["Meters.","Kilometers.","Miles."],"x-flint-enum":"closed"},"value":{"type":"number"}},"required":["unit","value"],"type":"object"},"DeliveryPickupAvailabilityMethodResource":{"properties":{"delivery_method_id":{"type":"string"},"delivery_method_revision_id":{"type":"string"}},"required":["delivery_method_id","delivery_method_revision_id"],"type":"object"},"DeliveryPickupAvailabilityQuantityResource":{"properties":{"bundle_component_id":{"type":"string"},"order_line_item_id":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"}},"required":["order_line_item_id","quantity"],"type":"object"},"DeliveryPickupAvailabilityResponse":{"properties":{"data":{"$ref":"#/components/schemas/DeliveryPickupAvailability"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeliveryPickupDetails":{"properties":{"location":{"$ref":"#/components/schemas/DeliveryLocationSummaryResource"},"pickup_mode":{"enum":["in_store","curbside","locker","other"],"type":"string","x-enum-descriptions":["In store.","Curbside.","Locker.","Other."],"x-flint-enum":"closed"}},"required":["pickup_mode"],"type":"object"},"DeliveryPlan":{"properties":{"complete_by_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"first_arrival_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"planned_delivery_count":{"type":"integer"},"type":{"enum":["single_delivery","multiple_deliveries"],"type":"string","x-enum-descriptions":["Single delivery.","Multiple deliveries."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"DeliveryPostalCodeCondition":{"additionalProperties":false,"properties":{"subject":{"default":"destination_address","description":"Address facts tested by this condition. destination_address is the shipping destination. buyer_location is the buyer's current pickup or local-delivery location.","enum":["destination_address","buyer_location"],"type":"string","x-enum-descriptions":["Destination address.","Buyer location."],"x-flint-enum":"closed"},"values":{"items":{"$ref":"#/components/schemas/DeliveryPostalCodeValue"},"type":"array"}},"required":["values"],"type":"object"},"DeliveryPostalCodeValue":{"additionalProperties":false,"properties":{"country":{"description":"ISO 3166-1 alpha-2 country code.","example":"US","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"type":{"default":"exact","enum":["exact","prefix"],"type":"string","x-enum-descriptions":["Exact.","Prefix."],"x-flint-enum":"closed"},"value":{"type":"string"}},"required":["country","value"],"type":"object"},"DeliveryPreview":{"properties":{"buyer_location":{"$ref":"#/components/schemas/DeliveryBuyerLocationResource"},"choice_groups":{"items":{"$ref":"#/components/schemas/DeliveryPreviewChoiceGroupResource"},"type":"array"},"currency":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"},"delivery_method_ids":{"items":{"type":"string"},"type":"array"},"destination_address":{"$ref":"#/components/schemas/DeliveryAddressResource"},"evaluated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"evaluation_status":{"enum":["complete","incomplete","degraded"],"type":"string","x-enum-descriptions":["Complete.","Incomplete.","Degraded."],"x-flint-enum":"open"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"input_requirements":{"items":{"$ref":"#/components/schemas/DeliveryInputRequirement"},"type":"array"},"line_items":{"items":{"$ref":"#/components/schemas/CreateOrderLineItem"},"type":"array"},"merchant_diagnostics":{"items":{"$ref":"#/components/schemas/DeliveryMerchantDiagnostic"},"type":"array"},"pickup_location_id":{"type":"string"},"selection_authority":{"type":"boolean"}},"required":["choice_groups","currency","delivery_method_ids","evaluated_at","evaluation_status","expires_at","input_requirements","line_items","merchant_diagnostics","selection_authority"],"type":"object"},"DeliveryPreviewChoiceGroupResource":{"properties":{"allowed_types":{"items":{"type":"string"},"type":"array"},"availability_status":{"enum":["ready","needs_input","needs_checkout_context","unavailable"],"type":"string","x-enum-descriptions":["Ready.","Needs input.","Needs checkout context.","Unavailable."],"x-flint-enum":"open"},"candidate_outcomes":{"additionalProperties":{"$ref":"#/components/schemas/DeliveryCandidateOutcomeResource"},"type":"object"},"evaluation_status":{"enum":["complete","incomplete","degraded"],"type":"string","x-enum-descriptions":["Complete.","Incomplete.","Degraded."],"x-flint-enum":"open"},"execution_legs":{"items":{"$ref":"#/components/schemas/DeliveryQuoteExecutionLegResource"},"type":"array"},"input_requirements":{"items":{"$ref":"#/components/schemas/DeliveryInputRequirement"},"type":"array"},"line_items":{"items":{"$ref":"#/components/schemas/DeliveryQuoteLineItemResource"},"type":"array"},"options":{"items":{"$ref":"#/components/schemas/DeliveryOptionProjection"},"type":"array"}},"required":["availability_status","candidate_outcomes","evaluation_status","input_requirements","line_items","options"],"type":"object"},"DeliveryPreviewResponse":{"properties":{"data":{"$ref":"#/components/schemas/DeliveryPreview"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeliveryPreviewRoutingSource":{"properties":{"inventory_allocation_policy_id":{"type":"string"},"inventory_allocation_policy_version_id":{"type":"string"},"location_id":{"type":"string"},"type":{"enum":["location","allocation_policy"],"type":"string","x-enum-descriptions":["Location.","Allocation policy."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"DeliveryPricingRate":{"additionalProperties":false,"properties":{"currency_options":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"delivery_rate_id":{"type":"string"},"priority":{"format":"int32","type":"integer"},"when":{"$ref":"#/components/schemas/DeliveryEligibilityExpression"}},"required":["currency_options","delivery_rate_id","priority"],"type":"object"},"DeliveryPricingRateCreateInput":{"additionalProperties":false,"properties":{"currency_options":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"priority":{"format":"int32","type":"integer"},"when":{"$ref":"#/components/schemas/DeliveryEligibilityExpression"}},"required":["priority","when","currency_options"],"type":"object"},"DeliveryPricingRateInput":{"additionalProperties":false,"properties":{"currency_options":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"delivery_rate_id":{"description":"Stable rate identifier returned by Flint. Include it when updating or retaining an existing rate.","type":"string"},"priority":{"format":"int32","type":"integer"},"when":{"$ref":"#/components/schemas/DeliveryEligibilityExpression"}},"required":["priority","when","currency_options"],"type":"object"},"DeliveryPricingStrategy":{"additionalProperties":false,"discriminator":{"propertyName":"type"},"oneOf":[{"not":{"anyOf":[{"required":["callback"]},{"required":["caller_supplied"]},{"required":["fixed"]},{"required":["rate_table"]},{"required":["tiered"]}]},"properties":{"type":{"const":"calculated"}},"required":["type","calculated"]},{"not":{"anyOf":[{"required":["calculated"]},{"required":["caller_supplied"]},{"required":["fixed"]},{"required":["rate_table"]},{"required":["tiered"]}]},"properties":{"type":{"const":"callback"}},"required":["type","callback"]},{"not":{"anyOf":[{"required":["calculated"]},{"required":["callback"]},{"required":["fixed"]},{"required":["rate_table"]},{"required":["tiered"]}]},"properties":{"type":{"const":"caller_supplied"}},"required":["type","caller_supplied"]},{"not":{"anyOf":[{"required":["calculated"]},{"required":["callback"]},{"required":["caller_supplied"]},{"required":["rate_table"]},{"required":["tiered"]}]},"properties":{"type":{"const":"fixed"}},"required":["type","fixed"]},{"not":{"anyOf":[{"required":["calculated"]},{"required":["callback"]},{"required":["caller_supplied"]},{"required":["fixed"]},{"required":["tiered"]}]},"properties":{"type":{"const":"rate_table"}},"required":["type","rate_table"]},{"not":{"anyOf":[{"required":["calculated"]},{"required":["callback"]},{"required":["caller_supplied"]},{"required":["fixed"]},{"required":["rate_table"]}]},"properties":{"type":{"const":"tiered"}},"required":["type","tiered"]}],"properties":{"calculated":{"$ref":"#/components/schemas/DeliveryCalculatedPricingStrategy"},"callback":{"$ref":"#/components/schemas/DeliveryExternalPricingStrategy"},"caller_supplied":{"$ref":"#/components/schemas/DeliveryExternalPricingStrategy"},"fixed":{"$ref":"#/components/schemas/DeliveryFixedPricingStrategy"},"rate_table":{"$ref":"#/components/schemas/DeliveryRateTablePricingStrategy"},"tiered":{"$ref":"#/components/schemas/DeliveryTieredPricingStrategy"},"type":{"enum":["fixed","rate_table","tiered","calculated","callback","caller_supplied"],"type":"string","x-enum-descriptions":["Fixed.","Rate table.","Tiered.","Calculated.","Callback.","Caller supplied."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"DeliveryPricingStrategyCreateInput":{"additionalProperties":false,"discriminator":{"propertyName":"type"},"oneOf":[{"not":{"anyOf":[{"required":["callback"]},{"required":["caller_supplied"]},{"required":["fixed"]},{"required":["rate_table"]},{"required":["tiered"]}]},"properties":{"type":{"const":"calculated"}},"required":["type","calculated"]},{"not":{"anyOf":[{"required":["calculated"]},{"required":["caller_supplied"]},{"required":["fixed"]},{"required":["rate_table"]},{"required":["tiered"]}]},"properties":{"type":{"const":"callback"}},"required":["type","callback"]},{"not":{"anyOf":[{"required":["calculated"]},{"required":["callback"]},{"required":["fixed"]},{"required":["rate_table"]},{"required":["tiered"]}]},"properties":{"type":{"const":"caller_supplied"}},"required":["type","caller_supplied"]},{"not":{"anyOf":[{"required":["calculated"]},{"required":["callback"]},{"required":["caller_supplied"]},{"required":["rate_table"]},{"required":["tiered"]}]},"properties":{"type":{"const":"fixed"}},"required":["type","fixed"]},{"not":{"anyOf":[{"required":["calculated"]},{"required":["callback"]},{"required":["caller_supplied"]},{"required":["fixed"]},{"required":["tiered"]}]},"properties":{"type":{"const":"rate_table"}},"required":["type","rate_table"]},{"not":{"anyOf":[{"required":["calculated"]},{"required":["callback"]},{"required":["caller_supplied"]},{"required":["fixed"]},{"required":["rate_table"]}]},"properties":{"type":{"const":"tiered"}},"required":["type","tiered"]}],"properties":{"calculated":{"$ref":"#/components/schemas/DeliveryCalculatedPricingStrategyInput"},"callback":{"$ref":"#/components/schemas/DeliveryCallbackPricingStrategyInput"},"caller_supplied":{"$ref":"#/components/schemas/DeliveryCallerSuppliedPricingStrategyInput"},"fixed":{"$ref":"#/components/schemas/DeliveryFixedPricingStrategyInput"},"rate_table":{"$ref":"#/components/schemas/DeliveryRateTablePricingStrategyCreateInput"},"tiered":{"$ref":"#/components/schemas/DeliveryTieredPricingStrategyInput"},"type":{"enum":["fixed","rate_table","tiered","calculated","callback","caller_supplied"],"type":"string","x-enum-descriptions":["Fixed.","Rate table.","Tiered.","Calculated.","Callback.","Caller supplied."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"DeliveryPricingStrategyInput":{"additionalProperties":false,"discriminator":{"propertyName":"type"},"oneOf":[{"not":{"anyOf":[{"required":["callback"]},{"required":["caller_supplied"]},{"required":["fixed"]},{"required":["rate_table"]},{"required":["tiered"]}]},"properties":{"type":{"const":"calculated"}},"required":["type","calculated"]},{"not":{"anyOf":[{"required":["calculated"]},{"required":["caller_supplied"]},{"required":["fixed"]},{"required":["rate_table"]},{"required":["tiered"]}]},"properties":{"type":{"const":"callback"}},"required":["type","callback"]},{"not":{"anyOf":[{"required":["calculated"]},{"required":["callback"]},{"required":["fixed"]},{"required":["rate_table"]},{"required":["tiered"]}]},"properties":{"type":{"const":"caller_supplied"}},"required":["type","caller_supplied"]},{"not":{"anyOf":[{"required":["calculated"]},{"required":["callback"]},{"required":["caller_supplied"]},{"required":["rate_table"]},{"required":["tiered"]}]},"properties":{"type":{"const":"fixed"}},"required":["type","fixed"]},{"not":{"anyOf":[{"required":["calculated"]},{"required":["callback"]},{"required":["caller_supplied"]},{"required":["fixed"]},{"required":["tiered"]}]},"properties":{"type":{"const":"rate_table"}},"required":["type","rate_table"]},{"not":{"anyOf":[{"required":["calculated"]},{"required":["callback"]},{"required":["caller_supplied"]},{"required":["fixed"]},{"required":["rate_table"]}]},"properties":{"type":{"const":"tiered"}},"required":["type","tiered"]}],"properties":{"calculated":{"$ref":"#/components/schemas/DeliveryCalculatedPricingStrategyInput"},"callback":{"$ref":"#/components/schemas/DeliveryCallbackPricingStrategyInput"},"caller_supplied":{"$ref":"#/components/schemas/DeliveryCallerSuppliedPricingStrategyInput"},"fixed":{"$ref":"#/components/schemas/DeliveryFixedPricingStrategyInput"},"rate_table":{"$ref":"#/components/schemas/DeliveryRateTablePricingStrategyInput"},"tiered":{"$ref":"#/components/schemas/DeliveryTieredPricingStrategyInput"},"type":{"enum":["fixed","rate_table","tiered","calculated","callback","caller_supplied"],"type":"string","x-enum-descriptions":["Fixed.","Rate table.","Tiered.","Calculated.","Callback.","Caller supplied."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"DeliveryPricingTierBand":{"additionalProperties":false,"properties":{"currency_options":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"from":{"format":"int64","type":"integer"},"to":{"format":"int64","type":"integer"}},"required":["currency_options","from"],"type":"object"},"DeliveryPricingTierBandInput":{"additionalProperties":false,"properties":{"currency_options":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"from":{"format":"int64","type":"integer"},"to":{"format":"int64","type":"integer"}},"required":["currency_options","from"],"type":"object"},"DeliveryProfile":{"additionalProperties":false,"properties":{"configuration":{"$ref":"#/components/schemas/DeliveryProfileConfiguration","description":"Current delivery requirement and grouping policy."},"created_at":{"description":"Time the profile was created.","format":"date-time","type":"string"},"current_delivery_profile_revision_id":{"description":"Immutable revision used for new line-item snapshots.","type":"string"},"delivery_profile_id":{"description":"Stable delivery profile ID.","type":"string"},"diagnostics":{"$ref":"#/components/schemas/DeliveryProfileDiagnostics","description":"Read-only catalog and delivery-method compatibility diagnostics.","readOnly":true},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"description":"Caller-owned metadata.","type":"object"},"name":{"description":"Merchant-facing profile name.","type":"string"},"status":{"description":"Current profile lifecycle status.","enum":["inactive","active","archived","revoked"],"type":"string","x-enum-descriptions":["Inactive.","Active.","Archived.","Revoked."],"x-flint-enum":"open"},"updated_at":{"description":"Time the profile last changed.","format":"date-time","type":"string"},"version":{"description":"Optimistic-concurrency version for profile writes.","format":"uint64","minimum":1,"type":"integer"}},"required":["delivery_profile_id","current_delivery_profile_revision_id","name","status","version","configuration","created_at","updated_at"],"type":"object"},"DeliveryProfileAssignment":{"properties":{"bundle_components_updated":{"description":"Number of previously unconfigured catalog records updated.","format":"int64","minimum":0,"type":"integer"},"delivery_profile_id":{"description":"Delivery profile assigned to each updated catalog item.","type":"string"},"product_variants_updated":{"description":"Number of previously unconfigured catalog records updated.","format":"int64","minimum":0,"type":"integer"}},"required":["bundle_components_updated","delivery_profile_id","product_variants_updated"],"type":"object"},"DeliveryProfileAssignmentResponse":{"properties":{"data":{"$ref":"#/components/schemas/DeliveryProfileAssignment"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeliveryProfileConfiguration":{"properties":{"allowed_types":{"description":"Required as a non-empty unique list when requirement is required. quote accepts shipment, pickup, and local_delivery. manual accepts digital and service.","items":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"type":"array"},"combination_policy":{"description":"Required for quote resolution and forbidden when requirement is none or resolution_mode is manual. Controls which delivery obligations can share a choice group.","enum":["combine_when_compatible","separate_profile","separate_line_item","fulfill_alone"],"type":"string","x-enum-descriptions":["Combine when compatible.","Separate profile.","Separate line item.","Fulfill alone."],"x-flint-enum":"closed"},"dimensions":{"$ref":"#/components/schemas/Dimensions","description":"Optional physical dimensions used by quote planning. Forbidden when requirement is none or resolution_mode is manual."},"origin_policy":{"$ref":"#/components/schemas/DeliveryProfileOriginPolicy","description":"Required for quote resolution and forbidden for none or manual resolution. fixed_location requires location_id. inventory_routing forbids location_id and applies only to tracked inventory. method_origin forbids location_id."},"requirement":{"description":"Whether delivery planning applies. none forbids every other configuration field. required also requires resolution_mode and allowed_types, plus the fields required by that resolution mode.","enum":["none","required"],"type":"string","x-enum-descriptions":["None.","Required."],"x-flint-enum":"closed"},"resolution_mode":{"description":"Required when requirement is required. quote plans physical delivery and requires origin_policy, combination_policy, and splitting_policy. manual supports digital and service items and forbids physical planning fields.","enum":["quote","manual"],"type":"string","x-enum-descriptions":["Quote.","Manual."],"x-flint-enum":"closed"},"splitting_policy":{"description":"Required for quote resolution and forbidden when requirement is none or resolution_mode is manual. Controls whether a line item quantity can be split across delivery assignments.","enum":["whole_line_item","quantity_split_allowed"],"type":"string","x-enum-descriptions":["Whole line item.","Quantity split allowed."],"x-flint-enum":"closed"},"weight":{"$ref":"#/components/schemas/Weight","description":"Optional physical weight used by quote planning. Forbidden when requirement is none or resolution_mode is manual."}},"required":["requirement"],"type":"object"},"DeliveryProfileConfigurationInput":{"additionalProperties":false,"oneOf":[{"not":{"anyOf":[{"required":["resolution_mode"]},{"required":["allowed_types"]},{"required":["origin_policy"]},{"required":["weight"]},{"required":["dimensions"]},{"required":["combination_policy"]},{"required":["splitting_policy"]}]},"properties":{"requirement":{"enum":["none"],"x-enum-descriptions":["None."],"x-flint-enum":"closed"}},"required":["requirement"]},{"properties":{"allowed_types":{"items":{"enum":["shipment","pickup","local_delivery"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery."],"x-flint-enum":"closed"},"minItems":1,"type":"array","uniqueItems":true},"requirement":{"enum":["required"],"x-enum-descriptions":["Required."],"x-flint-enum":"closed"},"resolution_mode":{"enum":["quote"],"x-enum-descriptions":["Quote."],"x-flint-enum":"closed"}},"required":["requirement","resolution_mode","allowed_types","origin_policy","combination_policy","splitting_policy"]},{"not":{"anyOf":[{"required":["origin_policy"]},{"required":["weight"]},{"required":["dimensions"]},{"required":["combination_policy"]},{"required":["splitting_policy"]}]},"properties":{"allowed_types":{"items":{"enum":["digital","service"],"type":"string","x-enum-descriptions":["Digital.","Service."],"x-flint-enum":"closed"},"minItems":1,"type":"array","uniqueItems":true},"requirement":{"enum":["required"],"x-enum-descriptions":["Required."],"x-flint-enum":"closed"},"resolution_mode":{"enum":["manual"],"x-enum-descriptions":["Manual."],"x-flint-enum":"closed"}},"required":["requirement","resolution_mode","allowed_types"]}],"properties":{"allowed_types":{"description":"Required as a non-empty unique list when requirement is required. quote accepts shipment, pickup, and local_delivery. manual accepts digital and service.","items":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"minItems":1,"type":"array","uniqueItems":true},"combination_policy":{"description":"Required for quote resolution and forbidden when requirement is none or resolution_mode is manual. Controls which delivery obligations can share a choice group.","enum":["combine_when_compatible","separate_profile","separate_line_item","fulfill_alone"],"type":"string","x-enum-descriptions":["Combine when compatible.","Separate profile.","Separate line item.","Fulfill alone."],"x-flint-enum":"closed"},"dimensions":{"$ref":"#/components/schemas/Dimensions","description":"Optional physical dimensions used by quote planning. Forbidden when requirement is none or resolution_mode is manual."},"origin_policy":{"$ref":"#/components/schemas/DeliveryProfileOriginPolicyInput","description":"Required for quote resolution and forbidden for none or manual resolution. fixed_location requires location_id. inventory_routing forbids location_id and applies only to tracked inventory. method_origin forbids location_id."},"requirement":{"description":"Whether delivery planning applies. none forbids every other configuration field. required also requires resolution_mode and allowed_types, plus the fields required by that resolution mode.","enum":["none","required"],"type":"string","x-enum-descriptions":["None.","Required."],"x-flint-enum":"closed"},"resolution_mode":{"description":"Required when requirement is required. quote plans physical delivery and requires origin_policy, combination_policy, and splitting_policy. manual supports digital and service items and forbids physical planning fields.","enum":["quote","manual"],"type":"string","x-enum-descriptions":["Quote.","Manual."],"x-flint-enum":"closed"},"splitting_policy":{"description":"Required for quote resolution and forbidden when requirement is none or resolution_mode is manual. Controls whether a line item quantity can be split across delivery assignments.","enum":["whole_line_item","quantity_split_allowed"],"type":"string","x-enum-descriptions":["Whole line item.","Quantity split allowed."],"x-flint-enum":"closed"},"weight":{"$ref":"#/components/schemas/Weight","description":"Optional physical weight used by quote planning. Forbidden when requirement is none or resolution_mode is manual."}},"type":"object"},"DeliveryProfileDiagnostics":{"additionalProperties":false,"properties":{"active_method_definitions_count":{"description":"Number of active delivery methods whose type is allowed by this profile.","minimum":0,"type":"integer"},"covers_all_items":{"description":"True when this is the physical catalog default and every active physical catalog obligation uses it.","type":"boolean"},"locations_without_rates_count":{"description":"Number of active Locations that no active delivery method compatible with this profile can use as an origin.","minimum":0,"type":"integer"},"unassigned_locations":{"description":"Up to 20 active Location IDs that no compatible active delivery method can use as an origin. Use locations_without_rates_count for the complete count.","items":{"type":"string"},"type":"array"},"unassigned_locations_truncated":{"description":"True when more matching Locations exist than are returned in unassigned_locations.","type":"boolean"},"zone_country_count":{"description":"Number of distinct countries explicitly named by zones referenced from compatible active delivery methods.","minimum":0,"type":"integer"}},"required":["covers_all_items","locations_without_rates_count","unassigned_locations","unassigned_locations_truncated","active_method_definitions_count","zone_country_count"],"type":"object"},"DeliveryProfileListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DeliveryProfile"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeliveryProfileOriginPolicy":{"properties":{"location_id":{"type":"string"},"type":{"enum":["fixed_location","inventory_routing","method_origin"],"type":"string","x-enum-descriptions":["Fixed location.","Inventory routing.","Method origin."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"DeliveryProfileOriginPolicyInput":{"additionalProperties":false,"oneOf":[{"properties":{"type":{"enum":["fixed_location"],"x-enum-descriptions":["Fixed location."],"x-flint-enum":"closed"}},"required":["type","location_id"]},{"not":{"anyOf":[{"required":["location_id"]}]},"properties":{"type":{"enum":["inventory_routing"],"x-enum-descriptions":["Inventory routing."],"x-flint-enum":"closed"}},"required":["type"]},{"not":{"anyOf":[{"required":["location_id"]}]},"properties":{"type":{"enum":["method_origin"],"x-enum-descriptions":["Method origin."],"x-flint-enum":"closed"}},"required":["type"]}],"properties":{"location_id":{"type":"string"},"type":{"enum":["fixed_location","inventory_routing","method_origin"],"type":"string","x-enum-descriptions":["Fixed location.","Inventory routing.","Method origin."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"DeliveryProfileResponse":{"properties":{"data":{"$ref":"#/components/schemas/DeliveryProfile"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeliveryQuote":{"properties":{"audience":{"const":"merchant","type":"string"},"basis_delivery_quote_id":{"type":"string"},"basis_delivery_selection_id":{"type":"string"},"buyer_location":{"$ref":"#/components/schemas/DeliveryBuyerLocationResource"},"checkout_session_id":{"type":"string"},"choice_groups":{"items":{"$ref":"#/components/schemas/DeliveryQuoteChoiceGroupResource"},"type":"array"},"consumed_by_delivery_selection_id":{"type":"string"},"delivery_quote_id":{"type":"string"},"delivery_quote_revision":{"format":"uint64","minimum":0,"type":"integer"},"destination_address":{"$ref":"#/components/schemas/DeliveryAddressInput"},"eligibility_context_revision":{"format":"uint64","minimum":0,"type":"integer"},"evaluated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"evaluation_status":{"enum":["complete","incomplete","degraded"],"type":"string","x-enum-descriptions":["Complete.","Incomplete.","Degraded."],"x-flint-enum":"open"},"expires_at":{"description":"Authoritative expiry for this quote. It can be shorter than the platform maximum because inventory and checkout deadlines also apply. Read this value from every response.","format":"date-time","type":"string"},"input_requirements":{"items":{"$ref":"#/components/schemas/DeliveryInputRequirement"},"type":"array"},"merchant_diagnostics":{"items":{"$ref":"#/components/schemas/DeliveryMerchantDiagnostic"},"type":"array"},"methods":{"items":{"$ref":"#/components/schemas/DeliveryQuoteMethodResource"},"type":"array"},"order_id":{"type":"string"},"pending_caller_rate_requests":{"items":{"$ref":"#/components/schemas/DeliveryPendingCallerRateRequest"},"type":"array"},"revocation_reason":{"enum":["configuration_changed","checkout_unavailable"],"type":"string","x-enum-descriptions":["Configuration changed.","Checkout unavailable."],"x-flint-enum":"closed"},"revoked_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"selection_required":{"type":"boolean"},"stale_reason":{"enum":["checkout_changed","selection_changed","eligibility_changed","inventory_changed","authority_changed","consumed_by_priced_quote"],"type":"string","x-enum-descriptions":["Checkout changed.","Selection changed.","Eligibility changed.","Inventory changed.","Authority changed.","Consumed by priced quote."],"x-flint-enum":"closed"},"status":{"enum":["active","consumed","stale","expired","revoked"],"type":"string","x-enum-descriptions":["Active.","Consumed.","Stale.","Expired.","Revoked."],"x-flint-enum":"open"}},"required":["audience","checkout_session_id","choice_groups","delivery_quote_id","delivery_quote_revision","eligibility_context_revision","evaluated_at","evaluation_status","expires_at","input_requirements","merchant_diagnostics","order_id","selection_required","status"],"type":"object"},"DeliveryQuoteChoiceGroupResource":{"properties":{"allowed_types":{"items":{"type":"string"},"type":"array"},"availability_status":{"enum":["ready","needs_input","needs_checkout_context","unavailable"],"type":"string","x-enum-descriptions":["Ready.","Needs input.","Needs checkout context.","Unavailable."],"x-flint-enum":"open"},"candidate_outcomes":{"additionalProperties":{"$ref":"#/components/schemas/DeliveryCandidateOutcomeResource"},"type":"object"},"delivery_choice_group_id":{"type":"string"},"evaluation_status":{"enum":["complete","incomplete","degraded"],"type":"string","x-enum-descriptions":["Complete.","Incomplete.","Degraded."],"x-flint-enum":"open"},"execution_legs":{"items":{"$ref":"#/components/schemas/DeliveryQuoteExecutionLegResource"},"type":"array"},"input_requirements":{"items":{"$ref":"#/components/schemas/DeliveryInputRequirement"},"type":"array"},"line_items":{"items":{"$ref":"#/components/schemas/DeliveryQuoteLineItemResource"},"type":"array"},"options":{"items":{"$ref":"#/components/schemas/DeliveryOptionProjection"},"type":"array"},"previously_selected_delivery_method_id":{"type":"string"},"stable_key":{"type":"string"}},"required":["availability_status","delivery_choice_group_id","evaluation_status","input_requirements","line_items","options","stable_key"],"type":"object"},"DeliveryQuoteExecutionLegResource":{"properties":{"delivery_execution_leg_id":{"type":"string"},"origin_location_id":{"type":"string"}},"required":["delivery_execution_leg_id","origin_location_id"],"type":"object"},"DeliveryQuoteLineItemResource":{"properties":{"bundle_component_id":{"type":"string"},"order_line_item_id":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"}},"required":["order_line_item_id","quantity"],"type":"object"},"DeliveryQuoteListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DeliveryQuote"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeliveryQuoteMethodResource":{"properties":{"delivery_method_id":{"type":"string"},"delivery_method_revision_id":{"type":"string"},"description":{"type":"string"},"display_position":{"format":"int32","type":"integer"},"name":{"type":"string"},"recommendation_priority":{"format":"int32","type":"integer"},"type":{"enum":["shipment","pickup","local_delivery"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery."],"x-flint-enum":"closed"}},"required":["delivery_method_id","delivery_method_revision_id","display_position","name","type"],"type":"object"},"DeliveryRadiusCondition":{"additionalProperties":false,"properties":{"maximum_distance":{"$ref":"#/components/schemas/DeliveryDistance"},"measurement":{"default":"straight_line","enum":["straight_line"],"type":"string","x-enum-descriptions":["Straight line."],"x-flint-enum":"closed"},"origin":{"$ref":"#/components/schemas/DeliveryRadiusOrigin"},"subject":{"default":"destination_address","description":"Address facts tested by this condition. destination_address is the shipping destination. buyer_location is the buyer's current pickup or local-delivery location.","enum":["destination_address","buyer_location"],"type":"string","x-enum-descriptions":["Destination address.","Buyer location."],"x-flint-enum":"closed"}},"required":["maximum_distance","origin"],"type":"object"},"DeliveryRadiusOrigin":{"additionalProperties":false,"properties":{"location_id":{"type":"string"},"method_origin":{"type":"boolean"}},"type":"object"},"DeliveryRateCallback":{"additionalProperties":false,"properties":{"circuit_failure_count":{"description":"Consecutive callback failures since the last successful response.","minimum":0,"type":"integer"},"circuit_state":{"enum":["closed","open","half_open"],"type":"string","x-enum-descriptions":["Closed.","Open.","Half open."],"x-flint-enum":"closed"},"configuration":{"$ref":"#/components/schemas/DeliveryRateCallbackConfiguration"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"current_delivery_rate_callback_revision_id":{"type":"string"},"delivery_rate_callback_id":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"key_id":{"type":"string"},"name":{"type":"string"},"secret":{"description":"Initial signing secret. Returned only by the create response.","readOnly":true,"type":"string"},"status":{"enum":["inactive","active","archived","revoked"],"type":"string","x-enum-descriptions":["Inactive.","Active.","Archived.","Revoked."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"version":{"format":"uint64","minimum":1,"type":"integer"}},"required":["delivery_rate_callback_id","current_delivery_rate_callback_revision_id","name","status","version","configuration","created_at","updated_at","circuit_state","circuit_failure_count"],"type":"object"},"DeliveryRateCallbackConfiguration":{"additionalProperties":false,"properties":{"maximum_request_bytes":{"default":262144,"format":"int64","maximum":1048576,"minimum":1,"type":"integer"},"maximum_response_bytes":{"default":262144,"format":"int64","maximum":1048576,"minimum":1,"type":"integer"},"preview_enabled":{"default":false,"type":"boolean"},"redirect_policy":{"default":"reject","enum":["reject"],"type":"string","x-enum-descriptions":["Reject."],"x-flint-enum":"closed"},"request_timeout_seconds":{"default":2,"maximum":10,"minimum":0.1,"type":"number"},"url":{"type":"string"}},"required":["url"],"type":"object"},"DeliveryRateCallbackConnectionCheck":{"properties":{"checked_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"delivery_rate_callback_id":{"type":"string"},"delivery_rate_callback_revision_id":{"type":"string"},"failure_category":{"enum":["connection_failed","authentication_or_http_error"],"type":"string","x-enum-descriptions":["Connection failed.","Authentication or http error."],"x-flint-enum":"closed"},"http_status_code":{"type":"integer"},"key_id":{"type":"string"},"latency_milliseconds":{"format":"int64","type":"integer"},"status":{"enum":["succeeded","failed"],"type":"string","x-enum-descriptions":["Succeeded.","Failed."],"x-flint-enum":"open"}},"required":["checked_at","delivery_rate_callback_id","delivery_rate_callback_revision_id","key_id","latency_milliseconds","status"],"type":"object"},"DeliveryRateCallbackConnectionCheckResponse":{"properties":{"data":{"$ref":"#/components/schemas/DeliveryRateCallbackConnectionCheck"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeliveryRateCallbackListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DeliveryRateCallback"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeliveryRateCallbackResponse":{"properties":{"data":{"$ref":"#/components/schemas/DeliveryRateCallback"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeliveryRateCallbackSigningKeyRotation":{"properties":{"delivery_rate_callback_id":{"type":"string"},"key_id":{"type":"string"},"secret":{"description":"New signing secret. Returned only by this rotation response.","readOnly":true,"type":"string"}},"required":["delivery_rate_callback_id","key_id","secret"],"type":"object"},"DeliveryRateCallbackSigningKeyRotationResponse":{"properties":{"data":{"$ref":"#/components/schemas/DeliveryRateCallbackSigningKeyRotation"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeliveryRateCallbackTestDelivery":{"properties":{"delivery_rate_callback_id":{"type":"string"},"delivery_rate_callback_revision_id":{"type":"string"},"failure_category":{"description":"Why the callback test failed and the action that can make the next test succeed.\n- `blocked_target`: Use a public HTTPS callback target allowed by Flint's outbound network policy.\n- `connection_error`: Restore network connectivity to the callback host, then test again.\n- `dns_error`: Fix the callback hostname or its DNS records, then test again.\n- `invalid_response`: Return the documented callback response status, headers, and JSON body, then test again.\n- `request_error`: Fix the callback request handling identified by the test result, then test again.\n- `timeout`: Acknowledge the callback within its configured timeout, then test again.\n- `tls_error`: Fix the callback certificate and TLS configuration, then test again.","enum":["blocked_target","connection_error","dns_error","invalid_response","request_error","timeout","tls_error"],"type":"string","x-enum-descriptions":["Blocked target.","Connection error.","Dns error.","Invalid response.","Request error.","Timeout.","Tls error."],"x-flint-enum":"closed","x-flint-enum-descriptions":{"blocked_target":"Use a public HTTPS callback target allowed by Flint's outbound network policy.","connection_error":"Restore network connectivity to the callback host, then test again.","dns_error":"Fix the callback hostname or its DNS records, then test again.","invalid_response":"Return the documented callback response status, headers, and JSON body, then test again.","request_error":"Fix the callback request handling identified by the test result, then test again.","timeout":"Acknowledge the callback within its configured timeout, then test again.","tls_error":"Fix the callback certificate and TLS configuration, then test again."}},"http_status_code":{"type":"integer"},"key_id":{"type":"string"},"latency_milliseconds":{"format":"int64","type":"integer"},"status":{"enum":["succeeded","failed"],"type":"string","x-enum-descriptions":["Succeeded.","Failed."],"x-flint-enum":"open"},"tested_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["delivery_rate_callback_id","delivery_rate_callback_revision_id","key_id","latency_milliseconds","status","tested_at"],"type":"object"},"DeliveryRateCallbackTestDeliveryResponse":{"properties":{"data":{"$ref":"#/components/schemas/DeliveryRateCallbackTestDelivery"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeliveryRateTablePricingStrategy":{"additionalProperties":false,"properties":{"rates":{"items":{"$ref":"#/components/schemas/DeliveryPricingRate"},"type":"array"},"unmatched_behavior":{"enum":["unavailable"],"type":"string","x-enum-descriptions":["Unavailable."],"x-flint-enum":"closed"}},"required":["rates","unmatched_behavior"],"type":"object"},"DeliveryRateTablePricingStrategyCreateInput":{"additionalProperties":false,"properties":{"rates":{"items":{"$ref":"#/components/schemas/DeliveryPricingRateCreateInput"},"type":"array"},"unmatched_behavior":{"default":"unavailable","enum":["unavailable"],"type":"string","x-enum-descriptions":["Unavailable."],"x-flint-enum":"closed"}},"required":["rates"],"type":"object"},"DeliveryRateTablePricingStrategyInput":{"additionalProperties":false,"properties":{"rates":{"items":{"$ref":"#/components/schemas/DeliveryPricingRateInput"},"type":"array"},"unmatched_behavior":{"default":"unavailable","enum":["unavailable"],"type":"string","x-enum-descriptions":["Unavailable."],"x-flint-enum":"closed"}},"required":["rates"],"type":"object"},"DeliveryRecipientRequirement":{"additionalProperties":false,"properties":{"field":{"enum":["name","email","phone"],"type":"string","x-enum-descriptions":["Name.","Email.","Phone."],"x-flint-enum":"closed"},"format":{"enum":["text","email","e164"],"type":"string","x-enum-descriptions":["Text.","Email.","E164."],"x-flint-enum":"closed"},"required":{"type":"boolean"}},"required":["field","required"],"type":"object"},"DeliveryRecipientResource":{"properties":{"email":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"}},"type":"object"},"DeliveryRevocation":{"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"delivery_revocation_id":{"type":"string"},"estimated_impact":{"$ref":"#/components/schemas/DeliveryRevocationImpact"},"merchant_note":{"type":"string"},"reason":{"enum":["unsafe_configuration","location_unavailable","credential_compromise","legal_requirement","other"],"type":"string","x-enum-descriptions":["Unsafe configuration.","Location unavailable.","Credential compromise.","Legal requirement.","Other."],"x-flint-enum":"closed"},"target":{"$ref":"#/components/schemas/DeliveryRevocationTarget"}},"required":["created_at","delivery_revocation_id","estimated_impact","reason","target"],"type":"object"},"DeliveryRevocationImpact":{"properties":{"active_quote_count":{"format":"int64","type":"integer"},"current_selection_count":{"format":"int64","type":"integer"}},"required":["active_quote_count","current_selection_count"],"type":"object"},"DeliveryRevocationResponse":{"properties":{"data":{"$ref":"#/components/schemas/DeliveryRevocation"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeliveryRevocationTarget":{"description":"A typed revocation target. Each target_type accepts only its resource-specific identifiers and concurrency field.","oneOf":[{"not":{"anyOf":[{"required":["delivery_rate_callback_id"]},{"required":["delivery_rate_callback_revision_id"]},{"required":["delivery_rate_callback_signing_key_id"]},{"required":["delivery_method_id"]},{"required":["delivery_method_revision_id"]},{"required":["expected_version"]}]},"properties":{"target_type":{"enum":["location_geography"],"x-enum-descriptions":["Location geography."],"x-flint-enum":"closed"}},"required":["target_type","location_id","location_geography_revision"]},{"not":{"anyOf":[{"required":["location_id"]},{"required":["location_geography_revision"]},{"required":["delivery_rate_callback_id"]},{"required":["delivery_rate_callback_revision_id"]},{"required":["delivery_method_id"]},{"required":["delivery_method_revision_id"]},{"required":["expected_version"]}]},"properties":{"target_type":{"enum":["callback_signing_key"],"x-enum-descriptions":["Callback signing key."],"x-flint-enum":"closed"}},"required":["target_type","delivery_rate_callback_signing_key_id"]},{"not":{"anyOf":[{"required":["location_id"]},{"required":["location_geography_revision"]},{"required":["delivery_rate_callback_revision_id"]},{"required":["delivery_rate_callback_signing_key_id"]},{"required":["delivery_method_id"]},{"required":["delivery_method_revision_id"]}]},"properties":{"target_type":{"enum":["delivery_rate_callback"],"x-enum-descriptions":["Delivery rate callback."],"x-flint-enum":"closed"}},"required":["target_type","delivery_rate_callback_id","expected_version"]},{"not":{"anyOf":[{"required":["location_id"]},{"required":["location_geography_revision"]},{"required":["delivery_rate_callback_signing_key_id"]},{"required":["delivery_method_id"]},{"required":["delivery_method_revision_id"]},{"required":["expected_version"]}]},"properties":{"target_type":{"enum":["delivery_rate_callback_revision"],"x-enum-descriptions":["Delivery rate callback revision."],"x-flint-enum":"closed"}},"required":["target_type","delivery_rate_callback_id","delivery_rate_callback_revision_id"]},{"not":{"anyOf":[{"required":["location_id"]},{"required":["location_geography_revision"]},{"required":["delivery_rate_callback_id"]},{"required":["delivery_rate_callback_revision_id"]},{"required":["delivery_rate_callback_signing_key_id"]},{"required":["delivery_method_revision_id"]}]},"properties":{"target_type":{"enum":["delivery_method"],"x-enum-descriptions":["Delivery method."],"x-flint-enum":"closed"}},"required":["target_type","delivery_method_id","expected_version"]},{"not":{"anyOf":[{"required":["location_id"]},{"required":["location_geography_revision"]},{"required":["delivery_rate_callback_id"]},{"required":["delivery_rate_callback_revision_id"]},{"required":["delivery_rate_callback_signing_key_id"]},{"required":["expected_version"]}]},"properties":{"target_type":{"enum":["delivery_method_revision"],"x-enum-descriptions":["Delivery method revision."],"x-flint-enum":"closed"}},"required":["target_type","delivery_method_id","delivery_method_revision_id"]}],"properties":{"delivery_method_id":{"type":"string"},"delivery_method_revision_id":{"type":"string"},"delivery_rate_callback_id":{"type":"string"},"delivery_rate_callback_revision_id":{"type":"string"},"delivery_rate_callback_signing_key_id":{"type":"string"},"expected_version":{"description":"Required for delivery_method and delivery_rate_callback targets. The revocation resolves and permanently fences only the exact current revision at this stable-resource version. Omit it for exact revision, geography, and signing-key targets.","format":"uint64","minimum":1,"type":"integer"},"location_geography_revision":{"format":"int64","type":"integer"},"location_id":{"type":"string"},"target_type":{"enum":["location_geography","callback_signing_key","delivery_rate_callback","delivery_rate_callback_revision","delivery_method","delivery_method_revision"],"type":"string","x-enum-descriptions":["Location geography.","Callback signing key.","Delivery rate callback.","Delivery rate callback revision.","Delivery method.","Delivery method revision."],"x-flint-enum":"closed"}},"required":["target_type"],"type":"object"},"DeliveryScheduleWindowRule":{"properties":{"availability":{"$ref":"#/components/schemas/DeliveryAvailability"},"offer_windows":{"description":"Legacy stored-revision field. New method writes derive window selection from estimate.type.","type":"boolean"}},"required":["availability","offer_windows"],"type":"object"},"DeliveryScheduleWindowRuleInput":{"additionalProperties":false,"properties":{"availability":{"$ref":"#/components/schemas/DeliveryAvailability"}},"required":["availability"],"type":"object"},"DeliverySelection":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money","description":"Delivery charge committed by this selection."},"buyer_location":{"$ref":"#/components/schemas/DeliveryBuyerLocationResource","description":"Buyer location snapshot used to evaluate pickup proximity."},"calculation_expires_at":{"description":"Deadline after which calculated pricing evidence is no longer valid.","format":"date-time","type":"string"},"checkout_session_id":{"description":"Checkout session that owns the selection.","type":"string"},"choices":{"description":"One chosen option for each required choice group.","items":{"$ref":"#/components/schemas/DeliverySelectionChoiceResource"},"type":"array"},"created_at":{"description":"Time the selection was created.","format":"date-time","type":"string"},"delivery_quote_id":{"description":"Quote from which this selection was made.","type":"string"},"delivery_quote_revision":{"description":"Quote revision from which this selection was created.","format":"uint64","minimum":0,"type":"integer"},"delivery_selection_id":{"description":"Stable delivery selection ID.","type":"string"},"destination_address":{"$ref":"#/components/schemas/DeliveryAddressResource","description":"Destination address snapshot used for delivery evaluation."},"eligibility_context_revision":{"description":"Checkout eligibility-context revision evaluated by this selection.","format":"uint64","minimum":0,"type":"integer"},"expires_at":{"description":"Deadline after which this provisional selection can no longer be committed.","format":"date-time","type":"string"},"instructions":{"description":"Buyer-provided delivery instructions.","type":"string"},"lifecycle_events":{"description":"Ordered lifecycle events recorded for this selection.","items":{"$ref":"#/components/schemas/DeliverySelectionLifecycleEventResource"},"type":"array"},"lifecycle_updated_at":{"description":"Time the selection lifecycle last changed.","format":"date-time","type":"string"},"limiting_deadline_reason":{"description":"Constraint that determined the selection expiry.","enum":["selection_guarantee_expiry","calculation_expiry","selection_maximum_lifetime","inventory_reservation_expiry","tax_validity_expiry","checkout_session_expiry"],"type":"string","x-enum-descriptions":["Selection guarantee expiry.","Calculation expiry.","Selection maximum lifetime.","Inventory reservation expiry.","Tax validity expiry.","Checkout session expiry."],"x-flint-enum":"closed"},"order_id":{"description":"Order affected by the selection.","type":"string"},"private_data_status":{"description":"Availability state of merchant-private selection evidence.","enum":["available","redacted"],"type":"string","x-enum-descriptions":["Available.","Redacted."],"x-flint-enum":"open"},"recipient":{"$ref":"#/components/schemas/DeliveryRecipientResource","description":"Recipient details captured with the selection."},"redacted_at":{"description":"Time merchant-private selection evidence was redacted.","format":"date-time","type":"string"},"status":{"description":"Current selection lifecycle status.","enum":["selected","locked_for_payment","committed","superseded","expired","released"],"type":"string","x-enum-descriptions":["Selected.","Locked for payment.","Committed.","Superseded.","Expired.","Released."],"x-flint-enum":"open"}},"required":["amount_money","calculation_expires_at","checkout_session_id","choices","created_at","delivery_quote_id","delivery_quote_revision","delivery_selection_id","eligibility_context_revision","expires_at","lifecycle_updated_at","limiting_deadline_reason","order_id","status"],"type":"object"},"DeliverySelectionChoiceResource":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"delivery_choice_group_id":{"type":"string"},"delivery_method_id":{"type":"string"},"delivery_option_id":{"type":"string"},"delivery_plan":{"$ref":"#/components/schemas/DeliveryPlan"},"delivery_window_id":{"type":"string"},"description":{"type":"string"},"discount_money":{"$ref":"#/components/schemas/Money"},"input":{"$ref":"#/components/schemas/DeliverySelectionInstructionsInput"},"local_delivery":{"$ref":"#/components/schemas/DeliveryLocalDeliveryDetails"},"merchant_reference":{"type":"string"},"name":{"type":"string"},"order_charge_id":{"type":"string"},"pickup":{"$ref":"#/components/schemas/DeliveryPickupDetails"},"shipment":{"$ref":"#/components/schemas/DeliveryShipmentDetails"},"stable_key":{"type":"string"},"tax_money":{"$ref":"#/components/schemas/Money"},"timezone":{"description":"IANA timezone for displaying window_start_at and window_end_at.","example":"America/New_York","type":"string"},"total_money":{"$ref":"#/components/schemas/Money"},"type":{"enum":["shipment","pickup","local_delivery"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery."],"x-flint-enum":"closed"},"window_end_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"window_start_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["amount_money","delivery_choice_group_id","delivery_method_id","delivery_option_id","delivery_plan","discount_money","name","stable_key","tax_money","total_money","type"],"type":"object"},"DeliverySelectionInstructionsInput":{"additionalProperties":false,"properties":{"delivery_window_id":{"type":"string"},"instructions":{"description":"Buyer instructions for the selected option, without leading or trailing whitespace. Send this field only when buyer_instructions.enabled is true.","maxLength":2000,"type":"string"}},"type":"object"},"DeliverySelectionLifecycleEventResource":{"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"delivery_selection_id":{"type":"string"},"delivery_selection_lifecycle_event_id":{"type":"string"},"reason":{"type":"string"},"status":{"enum":["selected","locked_for_payment","committed","superseded","expired","released"],"type":"string","x-enum-descriptions":["Selected.","Locked for payment.","Committed.","Superseded.","Expired.","Released."],"x-flint-enum":"open"}},"required":["created_at","delivery_selection_id","delivery_selection_lifecycle_event_id","reason","status"],"type":"object"},"DeliverySelectionRecipientRequest":{"additionalProperties":false,"properties":{"email":{"description":"Recipient email address. Required only when the selected delivery option requests it.","format":"email","maxLength":254,"type":"string"},"name":{"description":"Recipient name. Required only when the selected delivery option requests it.","maxLength":200,"type":"string"},"phone":{"description":"Recipient phone number in E.164 format. Required only when the selected delivery option requests it.","maxLength":16,"pattern":"^\\+[1-9][0-9]{7,14}$","type":"string"}},"type":"object"},"DeliverySelectionResponse":{"properties":{"data":{"$ref":"#/components/schemas/DeliverySelection"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeliverySelectionResult":{"properties":{"audience":{"const":"merchant","type":"string"},"checkout_session":{"$ref":"#/components/schemas/CheckoutSession"},"delivery_selection":{"$ref":"#/components/schemas/DeliverySelection"},"inventory_reservation":{"$ref":"#/components/schemas/DeliveryInventoryReservationSummary"},"order":{"$ref":"#/components/schemas/Order"}},"required":["audience","checkout_session","delivery_selection","order"],"type":"object"},"DeliveryShipmentDetails":{"properties":{"instructions":{"type":"string"},"service_level":{"type":"string"}},"type":"object"},"DeliveryStateCondition":{"additionalProperties":false,"properties":{"subject":{"default":"destination_address","description":"Address facts tested by this condition. destination_address is the shipping destination. buyer_location is the buyer's current pickup or local-delivery location.","enum":["destination_address","buyer_location"],"type":"string","x-enum-descriptions":["Destination address.","Buyer location."],"x-flint-enum":"closed"},"values":{"items":{"type":"string"},"type":"array"}},"required":["values"],"type":"object"},"DeliveryTieredPricingStrategy":{"additionalProperties":false,"oneOf":[{"properties":{"basis":{"enum":["choice_group.total_weight"],"x-enum-descriptions":["Choice group.total weight."],"x-flint-enum":"closed"}},"required":["unit"]},{"not":{"anyOf":[{"required":["unit"]}]},"properties":{"basis":{"enum":["choice_group.fulfillment_quantity","choice_group.merchandise_subtotal_before_discounts","choice_group.merchandise_subtotal_after_line_item_discounts","order.merchandise_subtotal_before_discounts","order.merchandise_subtotal_after_line_item_discounts"],"x-enum-descriptions":["Choice group.fulfillment quantity.","Choice group.merchandise subtotal before discounts.","Choice group.merchandise subtotal after line item discounts.","Order.merchandise subtotal before discounts.","Order.merchandise subtotal after line item discounts."],"x-flint-enum":"closed"}}}],"properties":{"bands":{"items":{"$ref":"#/components/schemas/DeliveryPricingTierBand"},"type":"array"},"basis":{"description":"Quantity measured by the tier bands. Money subtotal bases use minor currency units.","enum":["choice_group.total_weight","choice_group.fulfillment_quantity","choice_group.merchandise_subtotal_before_discounts","choice_group.merchandise_subtotal_after_line_item_discounts","order.merchandise_subtotal_before_discounts","order.merchandise_subtotal_after_line_item_discounts","caller.tier_key"],"type":"string","x-enum-descriptions":["Choice group.total weight.","Choice group.fulfillment quantity.","Choice group.merchandise subtotal before discounts.","Choice group.merchandise subtotal after line item discounts.","Order.merchandise subtotal before discounts.","Order.merchandise subtotal after line item discounts.","Caller.tier key."],"x-flint-enum":"closed"},"unit":{"description":"Required only for choice_group.total_weight and forbidden for every other basis.","enum":["gram","kilogram","ounce","pound"],"type":"string","x-enum-descriptions":["Gram.","Kilogram.","Ounce.","Pound."],"x-flint-enum":"closed"}},"required":["bands","basis"],"type":"object"},"DeliveryTieredPricingStrategyInput":{"additionalProperties":false,"oneOf":[{"properties":{"basis":{"enum":["choice_group.total_weight"],"x-enum-descriptions":["Choice group.total weight."],"x-flint-enum":"closed"}},"required":["unit"]},{"not":{"anyOf":[{"required":["unit"]}]},"properties":{"basis":{"enum":["choice_group.fulfillment_quantity","choice_group.merchandise_subtotal_before_discounts","choice_group.merchandise_subtotal_after_line_item_discounts","order.merchandise_subtotal_before_discounts","order.merchandise_subtotal_after_line_item_discounts"],"x-enum-descriptions":["Choice group.fulfillment quantity.","Choice group.merchandise subtotal before discounts.","Choice group.merchandise subtotal after line item discounts.","Order.merchandise subtotal before discounts.","Order.merchandise subtotal after line item discounts."],"x-flint-enum":"closed"}}}],"properties":{"bands":{"items":{"$ref":"#/components/schemas/DeliveryPricingTierBandInput"},"type":"array"},"basis":{"description":"Quantity measured by the tier bands. Money subtotal bases use minor currency units.","enum":["choice_group.total_weight","choice_group.fulfillment_quantity","choice_group.merchandise_subtotal_before_discounts","choice_group.merchandise_subtotal_after_line_item_discounts","order.merchandise_subtotal_before_discounts","order.merchandise_subtotal_after_line_item_discounts","caller.tier_key"],"type":"string","x-enum-descriptions":["Choice group.total weight.","Choice group.fulfillment quantity.","Choice group.merchandise subtotal before discounts.","Choice group.merchandise subtotal after line item discounts.","Order.merchandise subtotal before discounts.","Order.merchandise subtotal after line item discounts.","Caller.tier key."],"x-flint-enum":"closed"},"unit":{"description":"Required only for choice_group.total_weight and forbidden for every other basis.","enum":["gram","kilogram","ounce","pound"],"type":"string","x-enum-descriptions":["Gram.","Kilogram.","Ounce.","Pound."],"x-flint-enum":"closed"}},"required":["bands","basis"],"type":"object"},"DeliveryTransitTimeRule":{"properties":{"handling_days":{"$ref":"#/components/schemas/DeliveryBusinessDayRange"},"transit_days":{"$ref":"#/components/schemas/DeliveryBusinessDayRange"}},"required":["handling_days","transit_days"],"type":"object"},"DeliveryWeeklyInterval":{"properties":{"end_minute":{"type":"integer"},"end_weekday":{"type":"integer"},"start_minute":{"type":"integer"},"start_weekday":{"type":"integer"}},"required":["end_minute","end_weekday","start_minute","start_weekday"],"type":"object"},"DeliveryWeightUnitPrice":{"additionalProperties":false,"properties":{"currency_options":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"unit":{"description":"Weight unit used by unit_quantity.","enum":["gram","kilogram","ounce","pound"],"type":"string","x-enum-descriptions":["Gram.","Kilogram.","Ounce.","Pound."],"x-flint-enum":"closed"},"unit_quantity":{"description":"Whole-number quantity of the selected unit charged at each configured currency price; fractional quantities are not supported.","format":"int64","minimum":1,"type":"integer"}},"required":["currency_options","unit","unit_quantity"],"type":"object"},"DeliveryWeightUnitPriceInput":{"additionalProperties":false,"properties":{"currency_options":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"unit":{"description":"Weight unit used by unit_quantity.","enum":["gram","kilogram","ounce","pound"],"type":"string","x-enum-descriptions":["Gram.","Kilogram.","Ounce.","Pound."],"x-flint-enum":"closed"},"unit_quantity":{"description":"Whole-number quantity of the selected unit charged at each configured currency price; fractional quantities are not supported.","format":"int64","minimum":1,"type":"integer"}},"required":["currency_options","unit","unit_quantity"],"type":"object"},"DeliveryWindowRequest":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"delivery_window_id":{"type":"string"},"end_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"start_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["amount_money","delivery_window_id","end_at","expires_at","start_at"],"type":"object"},"DeliveryWindowResource":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"delivery_window_id":{"type":"string"},"end_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"start_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["amount_money","delivery_window_id","end_at","expires_at","start_at"],"type":"object"},"DeliveryWindowTimeCondition":{"additionalProperties":false,"properties":{"end_minute":{"type":"integer"},"start_minute":{"type":"integer"},"weekdays":{"items":{"type":"string"},"type":"array"}},"type":"object"},"DeliveryZone":{"additionalProperties":false,"properties":{"configuration":{"$ref":"#/components/schemas/DeliveryZoneConfiguration","description":"Current geographic eligibility conditions."},"created_at":{"description":"Time the zone was created.","format":"date-time","type":"string"},"current_delivery_zone_revision_id":{"description":"Immutable revision used for new quotes.","type":"string"},"delivery_zone_id":{"description":"Stable delivery zone ID.","type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"description":"Caller-owned metadata.","type":"object"},"name":{"description":"Merchant-facing zone name.","type":"string"},"status":{"description":"Current zone lifecycle status.","enum":["inactive","active","archived","revoked"],"type":"string","x-enum-descriptions":["Inactive.","Active.","Archived.","Revoked."],"x-flint-enum":"open"},"updated_at":{"description":"Time the zone last changed.","format":"date-time","type":"string"},"version":{"description":"Optimistic-concurrency version for zone writes.","format":"uint64","minimum":1,"type":"integer"}},"required":["delivery_zone_id","current_delivery_zone_revision_id","name","status","version","configuration","created_at","updated_at"],"type":"object"},"DeliveryZoneCondition":{"additionalProperties":false,"properties":{"delivery_zone_id":{"type":"string"},"subject":{"default":"destination_address","description":"Address facts tested by this condition. destination_address is the shipping destination. buyer_location is the buyer's current pickup or local-delivery location.","enum":["destination_address","buyer_location"],"type":"string","x-enum-descriptions":["Destination address.","Buyer location."],"x-flint-enum":"closed"}},"required":["delivery_zone_id"],"type":"object"},"DeliveryZoneConfiguration":{"additionalProperties":false,"description":"A reusable geographic predicate containing only country, state, postal_code, and radius conditions.","oneOf":[{"required":["all"]},{"required":["any"]},{"required":["not"]},{"required":["country"]},{"required":["state"]},{"required":["postal_code"]},{"required":["radius"]}],"properties":{"all":{"items":{"$ref":"#/components/schemas/DeliveryZoneConfiguration"},"maxItems":100,"minItems":1,"type":"array"},"any":{"items":{"$ref":"#/components/schemas/DeliveryZoneConfiguration"},"maxItems":100,"minItems":1,"type":"array"},"country":{"$ref":"#/components/schemas/DeliveryCountryCondition"},"not":{"$ref":"#/components/schemas/DeliveryZoneConfiguration"},"postal_code":{"$ref":"#/components/schemas/DeliveryPostalCodeCondition"},"radius":{"$ref":"#/components/schemas/DeliveryRadiusCondition"},"state":{"$ref":"#/components/schemas/DeliveryStateCondition"}},"type":"object"},"DeliveryZoneListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DeliveryZone"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeliveryZoneResponse":{"properties":{"data":{"$ref":"#/components/schemas/DeliveryZone"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DemoSession":{"properties":{"api_key":{"$ref":"#/components/schemas/DemoSessionAPIKey","readOnly":true},"demo_session_id":{"readOnly":true,"type":"string"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"sandbox_id":{"readOnly":true,"type":"string"}},"required":["api_key","demo_session_id","expires_at","sandbox_id"],"type":"object"},"DemoSessionAPIKey":{"properties":{"scopes":{"items":{"enum":["accounts.api_keys.read","accounts.api_keys.write","accounts.devices.read","accounts.devices.write","accounts.organizations.read","accounts.organizations.write","analytics.read","capabilities.read","checkouts.checkout_sessions.read","checkouts.checkout_sessions.write","checkouts.payment_links.read","checkouts.payment_links.write","commerce.bundles.read","commerce.bundles.write","commerce.catalog.read","commerce.catalog.write","commerce.credit_notes.read","commerce.credit_notes.write","commerce.delivery.read","commerce.delivery.write","commerce.inventory.read","commerce.inventory.write","commerce.inventory_locations.write","commerce.inventory_policies.write","commerce.inventory_reservations.write","commerce.invoices.read","commerce.invoices.write","commerce.orders.read","commerce.orders.write","commerce.products.read","commerce.products.write","commerce.promotions.read","commerce.promotions.write","commerce.refunds.read","commerce.refunds.tax_overrides.write","commerce.refunds.write","commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write","commerce.subscription_plans.read","commerce.subscription_plans.write","commerce.subscriptions.read","commerce.subscriptions.write","customers.read","customers.sessions.write","customers.write","developer.feedback_reports.read","developer.feedback_reports.write","developer.partner_apps.read","developer.partner_apps.write","developer.request_logs.self.detail.read","developer.request_logs.self.read","developer.resource_timelines.read","developer.sandboxes.read","developer.sandboxes.write","merchant_billing.read","merchants.account_sessions.write","merchants.locations.read","merchants.locations.write","merchants.onboarding.read","merchants.onboarding.write","merchants.profile.read","merchants.profile.write","money_movement.balance_transactions.read","money_movement.balances.read","money_movement.payout_settings.read","money_movement.payout_settings.write","money_movement.payouts.read","money_movement.payouts.write","payments.disputes.read","payments.payment_intents.read","payments.payment_intents.write","payments.payment_method_domains.read","payments.payment_method_domains.write","payments.payment_methods.read","payments.payment_methods.write","payments.payment_options.read","reports.read","reports.write","risk.controls.write","risk.read","risk.reviews.write","settings.read","settings.write","webhooks.read","webhooks.write"],"type":"string","x-enum-descriptions":["Accounts.api keys.read.","Accounts.api keys.write.","Accounts.devices.read.","Accounts.devices.write.","Accounts.organizations.read.","Accounts.organizations.write.","Analytics.read.","Capabilities.read.","Checkouts.checkout sessions.read.","Checkouts.checkout sessions.write.","Checkouts.payment links.read.","Checkouts.payment links.write.","Commerce.bundles.read.","Commerce.bundles.write.","Commerce.catalog.read.","Commerce.catalog.write.","Commerce.credit notes.read.","Commerce.credit notes.write.","Commerce.delivery.read.","Commerce.delivery.write.","Commerce.inventory.read.","Commerce.inventory.write.","Commerce.inventory locations.write.","Commerce.inventory policies.write.","Commerce.inventory reservations.write.","Commerce.invoices.read.","Commerce.invoices.write.","Commerce.orders.read.","Commerce.orders.write.","Commerce.products.read.","Commerce.products.write.","Commerce.promotions.read.","Commerce.promotions.write.","Commerce.refunds.read.","Commerce.refunds.tax overrides.write.","Commerce.refunds.write.","Commerce.return policies.write.","Commerce.return reasons.write.","Commerce.returns.decisions.write.","Commerce.returns.operations.write.","Commerce.returns.process.write.","Commerce.returns.read.","Commerce.returns.resolutions.write.","Commerce.returns.write.","Commerce.subscription plans.read.","Commerce.subscription plans.write.","Commerce.subscriptions.read.","Commerce.subscriptions.write.","Customers.read.","Customers.sessions.write.","Customers.write.","Developer.feedback reports.read.","Developer.feedback reports.write.","Developer.partner apps.read.","Developer.partner apps.write.","Developer.request logs.self.detail.read.","Developer.request logs.self.read.","Developer.resource timelines.read.","Developer.sandboxes.read.","Developer.sandboxes.write.","Merchant billing.read.","Merchants.account sessions.write.","Merchants.locations.read.","Merchants.locations.write.","Merchants.onboarding.read.","Merchants.onboarding.write.","Merchants.profile.read.","Merchants.profile.write.","Money movement.balance transactions.read.","Money movement.balances.read.","Money movement.payout settings.read.","Money movement.payout settings.write.","Money movement.payouts.read.","Money movement.payouts.write.","Payments.disputes.read.","Payments.payment intents.read.","Payments.payment intents.write.","Payments.payment method domains.read.","Payments.payment method domains.write.","Payments.payment methods.read.","Payments.payment methods.write.","Payments.payment options.read.","Reports.read.","Reports.write.","Risk.controls.write.","Risk.read.","Risk.reviews.write.","Settings.read.","Settings.write.","Webhooks.read.","Webhooks.write."],"x-flint-enum":"closed"},"type":"array"},"secret_key":{"type":"string"}},"required":["scopes","secret_key"],"type":"object"},"DemoSessionResponse":{"properties":{"data":{"$ref":"#/components/schemas/DemoSession"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeveloperAuthContext":{"allOf":[{"if":{"properties":{"auth_type":{"const":"oauth"}}},"then":{"required":["oauth_grant_id"]}},{"if":{"properties":{"auth_type":{"const":"api_key"}}},"then":{"required":["api_key_id"]}},{"if":{"properties":{"environment":{"const":"sandbox"}}},"then":{"required":["sandbox_id"]}}],"dependentRequired":{"context_id":["oauth_session_id"],"oauth_session_id":["context_id","name"]},"properties":{"api_key_id":{"type":"string"},"auth_type":{"enum":["api_key","oauth"],"type":"string","x-enum-descriptions":["Api key.","Oauth."],"x-flint-enum":"closed"},"context_id":{"type":"string"},"environment":{"enum":["sandbox","live"],"type":"string","x-enum-descriptions":["Sandbox.","Live."],"x-flint-enum":"closed"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"merchant_id":{"type":"string"},"name":{"type":"string"},"oauth_grant_id":{"type":"string"},"oauth_session_id":{"type":"string"},"organization_id":{"type":"string"},"sandbox_id":{"type":"string"},"scopes":{"items":{"type":"string"},"type":"array"}},"required":["auth_type","environment","merchant_id","scopes"],"type":"object"},"DeveloperAuthContextResponse":{"properties":{"data":{"$ref":"#/components/schemas/DeveloperAuthContext"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeveloperInitialAPIKeyRequest":{"properties":{"name":{"type":"string"},"sandbox_id":{"type":"string"},"scopes":{"items":{"type":"string"},"type":"array"}},"required":["name"],"type":"object"},"DeveloperSandbox":{"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"is_default":{"type":"boolean"},"name":{"type":"string"},"sandbox_id":{"type":"string"},"status":{"enum":["active","archived"],"type":"string","x-enum-descriptions":["Active.","Archived."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["is_default","name","sandbox_id","status"],"type":"object"},"DeveloperSandboxWithAPIKey":{"properties":{"api_key":{"$ref":"#/components/schemas/APIKey"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"is_default":{"type":"boolean"},"name":{"type":"string"},"sandbox_id":{"type":"string"},"secret_key":{"type":"string"},"status":{"enum":["active","archived"],"type":"string","x-enum-descriptions":["Active.","Archived."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["is_default","name","sandbox_id","status"],"type":"object"},"Device":{"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"device_id":{"readOnly":true,"type":"string"},"hardware_fingerprint":{"type":"string"},"location_id":{"type":"string"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"status":{"enum":["active","deleted"],"readOnly":true,"type":"string","x-enum-descriptions":["Active.","Deleted."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"}},"required":["device_id","name","status"],"type":"object"},"DeviceListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Device"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DeviceResponse":{"properties":{"data":{"$ref":"#/components/schemas/Device"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DigitalFulfillmentDetails":{"properties":{"delivered_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"delivery_url":{"type":"string"}},"type":"object"},"Dimensions":{"properties":{"height":{"format":"int64","type":"integer"},"length":{"format":"int64","type":"integer"},"unit":{"type":"string"},"width":{"format":"int64","type":"integer"}},"required":["height","length","unit","width"],"type":"object"},"DiscountPreview":{"properties":{"applied":{"items":{"$ref":"#/components/schemas/PromotionCandidate"},"type":"array"},"available":{"items":{"$ref":"#/components/schemas/PromotionCandidate"},"type":"array"},"skipped":{"items":{"$ref":"#/components/schemas/PromotionCandidate"},"type":"array"}},"required":["applied","available","skipped"],"type":"object"},"DiscountPreviewData":{"properties":{"discount_preview":{"$ref":"#/components/schemas/DiscountPreview"}},"required":["discount_preview"],"type":"object"},"DiscountPreviewRequest":{"properties":{"discount":{"$ref":"#/components/schemas/CreateOrderDiscount"}},"type":"object"},"DiscountPreviewResponse":{"properties":{"data":{"$ref":"#/components/schemas/DiscountPreviewData"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"Dispute":{"properties":{"action_required":{"type":"boolean"},"amount_money":{"$ref":"#/components/schemas/Money"},"case_type":{"enum":["inquiry","chargeback","compliance","resolution","block","other","bank_return"],"type":"string","x-enum-descriptions":["Inquiry.","Chargeback.","Compliance.","Resolution.","Block.","Other.","Bank return."],"x-flint-enum":"closed"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"customer":{"anyOf":[{"$ref":"#/components/schemas/ExpandedCustomerSummary"},{"type":"null"}]},"customer_id":{"type":"string"},"dispute_id":{"type":"string"},"evidence_deadline_passed":{"type":"boolean"},"evidence_due_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"evidence_response_allowed":{"type":"boolean"},"evidence_submission_count":{"format":"int32","type":"integer"},"evidence_submission_past_due":{"type":"boolean"},"fraud_warning_id":{"type":"string"},"merchant_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrderSummary"},{"type":"null"}]},"order_id":{"type":"string"},"payment_intent":{"anyOf":[{"$ref":"#/components/schemas/ExpandedPaymentIntentSummary"},{"type":"null"}]},"payment_intent_id":{"type":"string"},"payment_option":{"enum":["card","apple_pay","google_pay","affirm","ach_debit"],"type":"string","x-enum-descriptions":["Card.","Apple pay.","Google pay.","Affirm.","Ach debit."],"x-flint-enum":"closed"},"reason":{"enum":["bank_cannot_process","check_returned","credit_not_processed","customer_initiated","debit_not_authorized","duplicate","fraudulent","general","incorrect_account_details","insufficient_funds","noncompliant","product_not_received","product_unacceptable","subscription_canceled","unrecognized","bank_account_closed","bank_account_not_found","bank_debit_not_authorized","bank_account_restricted","other"],"type":"string","x-enum-descriptions":["Bank cannot process.","Check returned.","Credit not processed.","Customer initiated.","Debit not authorized.","Duplicate.","Fraudulent.","General.","Incorrect account details.","Insufficient funds.","Noncompliant.","Product not received.","Product unacceptable.","Subscription canceled.","Unrecognized.","Bank account closed.","Bank account not found.","Bank debit not authorized.","Bank account restricted.","Other."],"x-flint-enum":"closed"},"status":{"enum":["warning_needs_response","warning_under_review","warning_closed","needs_response","under_review","won","lost","prevented"],"type":"string","x-enum-descriptions":["Warning needs response.","Warning under review.","Warning closed.","Needs response.","Under review.","Won.","Lost.","Prevented."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["action_required","amount_money","case_type","created_at","dispute_id","evidence_deadline_passed","evidence_response_allowed","evidence_submission_count","evidence_submission_past_due","merchant_id","metadata","reason","status","updated_at"],"type":"object"},"DisputeListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Dispute"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DisputeResponse":{"properties":{"data":{"$ref":"#/components/schemas/Dispute"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"DocumentTaxID":{"properties":{"country":{"description":"Two-letter ISO 3166-1 alpha-2 country code.","example":"US","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"document_tax_id":{"description":"Server-generated identity of an existing entry. Omit when adding an entry.","pattern":"^dti_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"identifier_type":{"description":"Provider-independent identifier type, for example vat, gst, or ein. This is an open vocabulary.","maxLength":64,"minLength":1,"pattern":"^[a-z][a-z0-9_]*$","type":"string"},"region":{"maxLength":64,"minLength":1,"type":"string"},"value":{"description":"Full identifier printed on documents. Not verified by Flint.","maxLength":255,"minLength":1,"type":"string"}},"required":["country","identifier_type","value"],"type":"object"},"EffectiveDeliverySelectionResource":{"properties":{"audience":{"const":"merchant","type":"string"},"delivery_selection":{"anyOf":[{"$ref":"#/components/schemas/DeliverySelection"},{"type":"null"}]},"mutable":{"type":"boolean"},"originating_checkout_session_id":{"type":"string"},"source":{"enum":["none","provisional","committed"],"type":"string","x-enum-descriptions":["None.","Provisional.","Committed."],"x-flint-enum":"closed"}},"required":["audience","mutable","source"],"type":"object"},"EmailChangeRequest":{"properties":{"confirmed":{"type":"boolean"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"current_email_confirmation_required":{"type":"boolean"},"customer_id":{"type":"string"},"email_change_request_id":{"type":"string"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"new_email":{"type":"string"}},"required":["confirmed","created_at","current_email_confirmation_required","customer_id","email_change_request_id","expires_at","new_email"],"type":"object"},"EmailChangeRequestResponse":{"properties":{"data":{"$ref":"#/components/schemas/EmailChangeRequest"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"EmbeddedMerchantAccountSessionExternalAction":{"additionalProperties":false,"properties":{"kind":{"enum":["embedded"],"type":"string","x-enum-descriptions":["Embedded."],"x-flint-enum":"closed"},"launch_token":{"type":"string"},"launch_token_expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"provider_session_expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"stripe":{"$ref":"#/components/schemas/MerchantAccountSessionStripeLaunch"}},"required":["kind","provider_session_expires_at","launch_token","launch_token_expires_at","stripe"],"type":"object"},"ErrorDetail":{"properties":{"allowed_key_modes":{"description":"API key modes in which this scope may be granted.","items":{"enum":["live","test"],"type":"string","x-enum-descriptions":["Live.","Test."],"x-flint-enum":"closed"},"type":"array"},"available_quantity":{"description":"Whole-number quantity currently available for the requested operation; fractional quantities are not supported.","format":"int64","type":"integer"},"blocking_resource_count":{"format":"int64","type":"integer"},"blocking_resources":{"description":"Bounded resources that must transition or be corrected before the operation can succeed.","items":{"$ref":"#/components/schemas/ErrorResourceReference"},"type":"array"},"capability":{"description":"Flint capability associated with this error, when applicable.","type":"string"},"capturable_money":{"$ref":"#/components/schemas/Money"},"captured_physical_revision":{"description":"Physical revision captured when the inventory count started.","format":"uint64","minimum":0,"type":"integer"},"code":{"type":"string"},"conflict_type":{"enum":["physical_revision","source_observation_sequence"],"type":"string","x-enum-descriptions":["Physical revision.","Source observation sequence."],"x-flint-enum":"closed"},"conflicting_fields":{"items":{"type":"string"},"type":"array"},"current_checkout_session_id":{"type":"string"},"current_money":{"$ref":"#/components/schemas/Money","description":"Current money amount counted toward the threshold, when the error is threshold-based."},"current_physical_revision":{"description":"Current physical revision observed when applying the inventory count.","format":"uint64","minimum":0,"type":"integer"},"current_resource":{"description":"Current fulfillment, shipment, or package returned when a conditional write conflicts with resource state.","oneOf":[{"$ref":"#/components/schemas/Fulfillment"},{"$ref":"#/components/schemas/Shipment"},{"$ref":"#/components/schemas/Package"}]},"current_selection_id":{"description":"Current effective delivery selection ID returned with a selection concurrency conflict.","type":"string"},"current_source_observation_sequence":{"description":"Latest accepted absolute source sequence for this item and Location.","format":"uint64","minimum":0,"type":"integer"},"current_status":{"description":"Current lifecycle status of the resource when the requested mutation is not allowed.","type":"string"},"current_version":{"description":"Current mutable resource version observed when a conditional mutation failed.","format":"uint64","minimum":0,"type":"integer"},"demand_key":{"type":"string"},"dependency_type":{"description":"Stable dependency category blocking a Location lifecycle transition.","enum":["devices","fulfillment","inventory_allocation_policies","inventory_capability","inventory_claims","inventory_counts","inventory_levels","inventory_transfers","settings"],"type":"string","x-enum-descriptions":["Devices.","Fulfillment.","Inventory allocation policies.","Inventory capability.","Inventory claims.","Inventory counts.","Inventory levels.","Inventory transfers.","Settings."],"x-flint-enum":"closed"},"eligibility_reason":{"enum":["location_not_active","inventory_not_configured","inventory_allocation_inactive","outside_policy","outside_allowed_set","destination_missing","geography_unavailable","item_unavailable","forced_location_mismatch","fulfillment_incompatible","split_prohibited","insufficient_quantity"],"type":"string","x-enum-descriptions":["Location not active.","Inventory not configured.","Inventory allocation inactive.","Outside policy.","Outside allowed set.","Destination missing.","Geography unavailable.","Item unavailable.","Forced location mismatch.","Fulfillment incompatible.","Split prohibited.","Insufficient quantity."],"x-flint-enum":"closed"},"existing_checkout_session_id":{"type":"string"},"expected_attempt_outstanding_money":{"$ref":"#/components/schemas/Money"},"gap_money":{"$ref":"#/components/schemas/Money","description":"Additional money amount needed to satisfy the threshold, when the error is threshold-based."},"inventory_count_line_id":{"type":"string"},"inventory_item_id":{"type":"string"},"is_resumable":{"type":"boolean"},"limit":{"format":"int64","type":"integer"},"location_id":{"type":"string"},"location_outcome":{"type":"string"},"maximum_money":{"$ref":"#/components/schemas/Money","description":"Maximum money amount accepted by the failed validation, calculated from the current resource state."},"message":{"type":"string"},"param":{"type":"string"},"payment_attempt_id":{"type":"string"},"payment_attempt_status":{"description":"Current Flint order payment attempt status associated with this error.","enum":["open","requires_action","processing","requires_capture","requires_retry","finalizing","partially_succeeded","succeeded","failed","canceled","expired"],"type":"string","x-enum-descriptions":["Open.","Requires action.","Processing.","Requires capture.","Requires retry.","Finalizing.","Partially succeeded.","Succeeded.","Failed.","Canceled.","Expired."],"x-flint-enum":"open"},"payment_intent_ids":{"items":{"type":"string"},"type":"array"},"payment_method_domain_id":{"type":"string"},"payment_option":{"description":"Flint payment option associated with this error, when the error is about a specific requested or selected payment option.","enum":["card","apple_pay","google_pay","affirm","ach_debit"],"type":"string","x-enum-descriptions":["Card.","Apple pay.","Google pay.","Affirm.","Ach debit."],"x-flint-enum":"closed"},"quota":{"$ref":"#/components/schemas/QuotaDetails","description":"Structured resource quota state when the error is caused by quota exhaustion."},"reason":{"description":"Stable Flint reason code associated with this error. For payment option availability errors this matches PaymentOptionBlocker.code. When code is PROMOTION_DECLINED, branch on reason. Promotion decline reasons are: not_eligible, minimum_not_met, expired, not_yet_started, exhausted, code_required, code_invalid, disabled, automatic_disabled, codes_disabled, already_applied, not_combinable, superseded_by_better_offer, superseded, max_promotions_reached, no_discountable_balance, buy_item_missing, currency_mismatch, unknown_type.","type":"string"},"remediation":{"$ref":"#/components/schemas/ErrorRemediation"},"requested_key_mode":{"description":"API key mode requested for the rejected scope grant.","enum":["live","test"],"type":"string","x-enum-descriptions":["Live.","Test."],"x-flint-enum":"closed"},"requested_quantity":{"description":"Whole-number quantity submitted by the caller when a quantity-bearing operation conflicts with current capacity; fractional quantities are not supported.","format":"int64","type":"integer"},"required_money":{"$ref":"#/components/schemas/Money","description":"Money amount required to satisfy a minimum threshold, when the error is threshold-based."},"risk_rule_ids":{"items":{"type":"string"},"type":"array"},"scope":{"description":"Canonical public scope rejected by validation, when the detail concerns one scope.","type":"string"},"selectable_payment_intents":{"items":{"$ref":"#/components/schemas/SelectableOrderPaymentIntent"},"type":"array"},"shortage_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"submitted_money":{"$ref":"#/components/schemas/Money"},"submitted_source_observation_sequence":{"description":"Absolute source sequence submitted for this inventory count line.","format":"uint64","minimum":0,"type":"integer"},"suggestions":{"description":"Concrete corrective actions for this validation error.","items":{"type":"string"},"type":"array"},"supported_actions":{"description":"Actions accepted for the current resource state.","items":{"type":"string"},"type":"array"},"supported_api_versions":{"items":{"type":"string"},"type":"array"},"tip_capable_money":{"$ref":"#/components/schemas/Money"}},"required":["code","message"],"type":"object"},"ErrorEnvelope":{"properties":{"error":{"$ref":"#/components/schemas/ErrorObject"}},"required":["error"],"type":"object"},"ErrorObject":{"properties":{"capability":{"description":"Flint capability associated with this error, when applicable.","type":"string"},"capturable_money":{"$ref":"#/components/schemas/Money"},"code":{"description":"Stable Flint error code. Use x-flint-error-codes on each operation to discover the codes relevant to that call.","enum":["ACCOUNT_SETUP_CONFIGURATION_CONFLICT","ACCOUNT_SETUP_REPAIR_REQUIRED","ACCOUNT_SETUP_REQUIRED","ACCOUNT_SETUP_UNAVAILABLE","ACTIVE_BUNDLE_COMPONENTS_IMMUTABLE","ACTIVE_DEMO_SESSION_EXISTS","ACTIVE_OPTIONS_REQUIRED","ACTIVE_OPTION_SELECTOR_COLLAPSE","ACTIVE_VARIANTS_REQUIRE_OPTION_BACKFILL","AFFIRM_REFUND_RETRY_NOT_ALLOWED","AMBIGUOUS_AUTH","AMOUNT_MONEY_CURRENCY_REQUIRED","AMOUNT_MONEY_REQUIRED","API_KEYS_UNAVAILABLE","API_KEY_DATA_INVALID","API_KEY_EXPIRED","API_KEY_MODE_MISMATCH","API_KEY_NOT_FOUND","API_KEY_REQUIRED","API_KEY_REVOKED","API_KEY_SANDBOX_UNAVAILABLE","API_KEY_SCOPE_INVALID","API_KEY_SCOPE_UNSUPPORTED","API_VERSION_CHANGED","API_VERSION_RETIRED","APPLICATION_METHOD_REQUIRED","ARCHIVED_CATEGORY","AUTHENTICATION_FAILED","AUTHENTICATION_REQUIRED","AUTHORIZATION_FAILED","AUTH_CONTEXT_MISSING","AUTH_REQUIRED","AUTH_UNAVAILABLE","AUTH_VALIDATION_FAILED","AUTOMATIC_PAYOUT_NOT_CANCELABLE","AUTOMATIC_TAX_COMPONENTS_FORBIDDEN","AUTOMATIC_TAX_EXEMPTION_UNSUPPORTED","AUTOMATIC_TAX_INVOICE_INSTALLMENTS_UNSUPPORTED","AUTOMATIC_TAX_MULTIPLE_DESTINATIONS","AUTOMATIC_TAX_MULTIPLE_ORIGINS","AUTOMATIC_TAX_PARTIAL_PAYMENT_UNSUPPORTED","AUTOMATIC_TAX_POST_TAX_DISCOUNT_UNSUPPORTED","AVAILABLE_MERCHANT","BALANCE_SNAPSHOT_UNAVAILABLE","BALANCE_SOURCE_TYPE_REQUIRED","BALANCE_TRANSACTION_NOT_FOUND","BANK_ACCOUNT_CLOSED","BANK_ACCOUNT_NOT_FOUND","BANK_ACCOUNT_RESTRICTED","BANK_DEBIT_LIMIT_EXCEEDED","BANK_DEBIT_NOT_AUTHORIZED","BUNDLE_COMPONENTS_REQUIRED","BUNDLE_COMPONENT_PRODUCT_NOT_ACTIVE","BUNDLE_COMPONENT_VARIANT_NOT_ACTIVE","BUNDLE_NOT_SELLABLE","BUYER_FULFILLMENT_CORRELATION_FORBIDDEN","BUYER_INVOICE_CREDENTIAL_INVALID","BUYER_INVOICE_CREDENTIAL_REQUIRED","CANNOT_PAUSE","CANNOT_RESUME","CANNOT_RESUME_INITIAL_PAYMENT_PENDING","CANNOT_RESUME_PAST_DUE_PAYMENT_REQUIRED","CAPABILITIES_UNAVAILABLE","CAPABILITY_SET_UNSUPPORTED","CAPABILITY_SNAPSHOT_UNAVAILABLE","CAPTURE_AMOUNT_EXCEEDS_CAPTURABLE","CAPTURE_CURRENCY_MISMATCH","CARD_DECLINED","CATALOG_INVENTORY_RELATIONSHIP_INVALID","CATALOG_LINE_ITEM_CURRENCY_CHANGED","CATALOG_LINE_ITEM_FIELDS_READ_ONLY","CATALOG_LINE_ITEM_SOURCE_CHANGED","CATALOG_MODIFIERS_REQUIRED","CATEGORY_HANDLE_EXISTS","CATEGORY_MODIFIED","CATEGORY_REFERENCED","CATEGORY_TARGETED","CHALLENGE_FAILED","CHALLENGE_REQUIRED","CHALLENGE_TOKEN_INVALID","CHARGE_NAME_REQUIRED","CHARGE_TYPE_REQUIRED","CHECKOUT_CREDENTIAL_CHANGED","CHECKOUT_DISCOUNT_ID_NOT_ALLOWED","CHECKOUT_DISCOUNT_NOT_REMOVABLE","CHECKOUT_LAUNCH_TOKEN_RESTRICTED","CHECKOUT_MANUAL_DISCOUNT_NOT_ALLOWED","CHECKOUT_ORDER_UPDATE_FIELD_NOT_ALLOWED","CHECKOUT_PAYMENT_RESOLVING","CHECKOUT_RECOVERY_ATTEMPT_MISMATCH","CHECKOUT_RECOVERY_RESTRICTED","CHECKOUT_REPLACEMENT_REQUIRES_ORDER","CHECKOUT_SESSIONS_UNAVAILABLE","CHECKOUT_SESSION_ALREADY_EXISTS","CHECKOUT_SESSION_AUTH_REQUIRED","CHECKOUT_SESSION_AUTH_UNAVAILABLE","CHECKOUT_SESSION_CURRENT_CHANGED","CHECKOUT_SESSION_LOOKUP_FAILED","CHECKOUT_SESSION_MODIFIERS_READ_ONLY","CHECKOUT_SESSION_MODIFIER_FIELDS_ONLY","CHECKOUT_SESSION_MODIFIER_UPDATE_LINE_ITEM_MISSING","CHECKOUT_SESSION_MODIFIER_UPDATE_MISSING_ORDER","CHECKOUT_SESSION_NOT_FOUND","CHECKOUT_SESSION_NOT_OPEN","CHECKOUT_SESSION_ORDER_MISMATCH","CHECKOUT_SESSION_PAYMENT_REQUIRED","CHECKOUT_SESSION_REQUIRED","CHECKOUT_SESSION_REVISION_CONFLICT","CHECKOUT_SESSION_REVISION_REQUIRED","CHECKOUT_SESSION_REVISION_UNAVAILABLE","CHECKOUT_SESSION_SCOPE_MISMATCH","CHECKOUT_SESSION_SECRET_REQUIRED","CHECKOUT_TAX_CALCULATION_LIMIT_REACHED","CHECKOUT_TIPPING_DISABLED","CHECKOUT_TIP_NOT_ALLOWED","CLERK_EMAIL_MISSING","CLERK_EMAIL_VERIFY_FAILED","CLERK_USER_CREATE_FAILED","CLERK_USER_LOOKUP_FAILED","CODE_TOO_LONG","COMPONENT_REQUIRED","CONCURRENT_MODIFICATION","CONFIRMATION_RETURN_URL_INVALID","CONFIRMATION_RETURN_URL_NOT_ALLOWED","CONFIRMATION_RETURN_URL_REQUIRED","CONTEXT_NOT_FOUND","COUNTRY_NOT_SUPPORTED","CREATE_ORDER_LINE_ITEM_DISCOUNT_UNSUPPORTED","CREDIT_NOTE_ALLOCATION_ALREADY_REVERSED","CREDIT_NOTE_ALLOCATION_EXCEEDS_BALANCE","CREDIT_NOTE_AMOUNT_EXCEEDS_CREDITABLE","CREDIT_NOTE_CHANGED","CREDIT_NOTE_CURRENCY_MISMATCH","CREDIT_NOTE_HAS_ALLOCATIONS","CREDIT_NOTE_ISSUE_IN_PROGRESS","CREDIT_NOTE_NOT_DRAFT","CREDIT_NOTE_NOT_ISSUED","CREDIT_NOTE_REFUND_EXCEEDS_BALANCE","CREDIT_NOTE_REFUND_INVALID","CURRENCY_MISMATCH","CURSOR_MISMATCH","CUSTOMER_ACCOUNTS_UNAVAILABLE","CUSTOMER_ACCOUNT_RESOURCE_NOT_FOUND","CUSTOMER_DELETION_BLOCKED","CUSTOMER_DELETION_PROCESSING","CUSTOMER_EMAIL_ALREADY_USED","CUSTOMER_SESSIONS_UNAVAILABLE","CUSTOMER_SESSION_EXPIRED","CUSTOMER_SESSION_NOT_FOUND","CUSTOMER_SESSION_REFRESH_EXPIRED","CUSTOMER_SESSION_REFRESH_REUSED","CUSTOMER_SESSION_REQUIRED","CUSTOM_DOMAIN_NOT_VERIFIED","DAILY_LIMIT_EXCEEDED","DANGLING_EXPANSION_REFERENCE","DEFAULT_ENVIRONMENT_REQUIRED","DEFAULT_PAYOUT_DESTINATIONS_MANAGED_EXTERNALLY","DEFAULT_PAYOUT_DESTINATION_INVALID","DEFAULT_PAYOUT_DESTINATION_REPLACEMENT_REQUIRED","DEFAULT_PAYOUT_DESTINATION_REQUIRED","DEFAULT_SANDBOX_CANNOT_BE_ARCHIVED","DEFAULT_SANDBOX_CANNOT_BE_RESET","DEFAULT_VARIANT_REQUIRED","DELIVERY_CALCULATION_EXPIRED","DELIVERY_CALLER_RATES_UNAVAILABLE_TO_BUYER","DELIVERY_COMMERCE_TREATMENT_UNSUPPORTED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_DEPENDENCY_REVOKED","DELIVERY_DESTINATION_ADDRESS_INCOMPLETE","DELIVERY_DESTINATION_ADDRESS_REQUIRED","DELIVERY_DESTINATION_CONTROLLED_BY_SELECTION","DELIVERY_DESTINATION_COUNTRY_INVALID","DELIVERY_DESTINATION_FIELD_TOO_LONG","DELIVERY_DESTINATION_FROZEN","DELIVERY_DESTINATION_INVALID","DELIVERY_DESTINATION_NOT_APPLICABLE","DELIVERY_DESTINATION_UPDATE_CONFLICT","DELIVERY_ELIGIBILITY_CONTEXT_CHANGED","DELIVERY_EXPECTED_SELECTION_REQUIRED","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_EXTERNAL_REFERENCE_REUSED","DELIVERY_FIELD_NOT_SUPPORTED","DELIVERY_FIELD_REQUIRED","DELIVERY_GROUPING_UNSUPPORTED","DELIVERY_MERCHANT_INPUT_REQUIRED","DELIVERY_METHODS_NOT_APPLICABLE","DELIVERY_METHOD_SERVICE_UNAVAILABLE","DELIVERY_OPTION_ALREADY_SELECTED","DELIVERY_OPTION_EXPIRED","DELIVERY_OPTION_NOT_IN_CHOICE_GROUP","DELIVERY_PICKUP_AVAILABILITY_CHANGED","DELIVERY_PICKUP_AVAILABILITY_INVALID","DELIVERY_PICKUP_AVAILABILITY_UNAVAILABLE","DELIVERY_PICKUP_LOCATION_UNAVAILABLE","DELIVERY_PREVIEW_INVALID","DELIVERY_PREVIEW_METHOD_TYPES_INCOMPATIBLE","DELIVERY_PREVIEW_REQUIRES_CHECKOUT","DELIVERY_PREVIEW_UNAVAILABLE","DELIVERY_PROFILE_NOT_APPLICABLE","DELIVERY_QUOTE_BASIS_INVALID","DELIVERY_QUOTE_EXPIRED","DELIVERY_QUOTE_INCOMPLETE","DELIVERY_QUOTE_INPUT_CHANGED","DELIVERY_QUOTE_INVALID","DELIVERY_QUOTE_REVOKED","DELIVERY_QUOTE_STALE","DELIVERY_QUOTE_UNAVAILABLE","DELIVERY_REQUEST_INVALID","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SELECTION_CHANGED","DELIVERY_SELECTION_EXPIRED","DELIVERY_SELECTION_INCOMPLETE","DELIVERY_SELECTION_NOT_MUTABLE_AFTER_PAYMENT","DELIVERY_SELECTION_REPLACEMENT_LIMIT","DELIVERY_SELECTION_UNAVAILABLE","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","DELIVERY_STATUS_INVALID","DELIVERY_WINDOW_EXPIRED","DELIVERY_WINDOW_INVALID","DEMO_SESSIONS_UNAVAILABLE","DEMO_SESSION_ROUTE_NOT_ALLOWED","DEMO_SESSION_SECRET_REPLAY_EXPIRED","DEVELOPER_MANAGEMENT_REQUIRES_LIVE_KEY","DISCOUNT_AMOUNT_INVALID","DISCOUNT_REQUIRED","DISPUTES_UNAVAILABLE","DISPUTE_NOT_FOUND","DUPLICATE_BUNDLE_COMPONENT_ID","DUPLICATE_CLIENT_OPTION_KEY","DUPLICATE_CLIENT_VALUE_KEY","DUPLICATE_CODE","DUPLICATE_COMPONENT_VARIANT","DUPLICATE_IMAGE_EXTERNAL_REFERENCE_ID","DUPLICATE_IMAGE_SOURCE","DUPLICATE_INVOICE_LINE","DUPLICATE_OPTION","DUPLICATE_OPTION_NAME","DUPLICATE_OPTION_VALUE","DUPLICATE_ORDER_CHARGE_ID","DUPLICATE_SCOPE","DUPLICATE_TAX_BREAKDOWN_REFUND","DUPLICATE_TAX_COMPONENT","DUPLICATE_VALUE","EMAIL_ALREADY_LINKED","EMAIL_CHANGE_CONFIRMATION_EXPIRED","EMAIL_CHANGE_CONFIRMATION_INVALID","EMAIL_CHANGE_DELIVERY_FAILED","EMAIL_CHANGE_RATE_LIMITED","EMAIL_REQUIRED","EMBEDDED_PAYMENT_RETURN_URL_REQUIRED","EMPTY_UPDATE","ENVIRONMENT_GRANT_NOT_FOUND","ENVIRONMENT_LOOKUP_FAILED","ENVIRONMENT_LOOKUP_UNAVAILABLE","ENVIRONMENT_REQUIRED","ENVIRONMENT_SELECTION_FORBIDDEN","EXACTLY_ONE_REQUIRED","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_LIMIT_EXCEEDED","EXPANSION_RESOLUTION_FAILED","EXPECTED_VERSION_REQUIRED","EXPIRED_CARD","EXTERNAL_API_KEY_REQUIRED","EXTERNAL_IMAGE_NOT_ALLOWED","EXTERNAL_TAX_COMPONENTS_REQUIRED","FEEDBACK_REPORTS_UNAVAILABLE","FEEDBACK_REPORT_NOT_FOUND","FIELD_NOT_ALLOWED_FOR_CALLER","FIELD_NOT_UPDATABLE","FIELD_REQUIRED","FIRST_NAME_REQUIRED","FLAT_TAX_PAYMENT_ATTRIBUTION_UNAVAILABLE","FLAT_TAX_PRICE_MODE_INVALID","FLAT_TAX_REFUND_MUST_BE_FULL","FLAT_TAX_REFUND_STATE_INVALID","FLAT_TAX_SCOPE_INVALID","FRAUD_WARNING_NOT_FOUND","FULFILLMENT_ACTION_NOT_ALLOWED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_BUNDLE_UNSUPPORTED","FULFILLMENT_CHANGED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_CONFIGURATION_ACTION_REQUIRED","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_PROFILE_REQUIRED","FULFILLMENT_PROFILE_REVISION_UNUSABLE","FULFILLMENT_PROFILE_UNAVAILABLE","FULFILLMENT_QUANTITY_EFFECT_REQUIRED","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_SELECTION_REQUIRED","FULFILLMENT_STATUS_REASON_TOO_LONG","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","HOSTED_INSTALL_UNAVAILABLE","IDEMPOTENCY_CLEAR_FAILED","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REQUIRED","IDEMPOTENCY_KEY_REUSED","IDEMPOTENCY_KEY_TOO_LONG","IDEMPOTENCY_LOAD_FAILED","IDEMPOTENCY_PERSIST_FAILED","IDEMPOTENCY_RECORD_INVALID","IDEMPOTENCY_RECOVERY_REQUIRED","IDEMPOTENCY_REQUEST_IN_PROGRESS","IDENTITY_RESOLUTION_FAILED","IMAGE_ANIMATION_UNSUPPORTED","IMAGE_ASSET_NOT_ATTACHABLE","IMAGE_ASSET_NOT_FOUND","IMAGE_DIMENSIONS_EXCEEDED","IMAGE_FORMAT_UNSUPPORTED","IMAGE_GALLERY_LIMIT_EXCEEDED","IMAGE_INGESTION_COUNT_EXCEEDED","IMAGE_INGESTION_EXPIRED","IMAGE_INGESTION_IN_PROGRESS","IMAGE_INGESTION_RESTART_REQUIRED","IMAGE_NOT_ATTACHABLE","IMAGE_OWNER_NOT_MUTABLE","IMAGE_PIXEL_BUDGET_EXCEEDED","IMAGE_PROCESSING_CAPACITY_EXCEEDED","IMAGE_PROCESSING_FAILED","IMAGE_PROCESSING_TIMEOUT","IMAGE_REVISION_MISMATCH","IMAGE_SOURCE_FETCH_FAILED","IMAGE_SOURCE_NOT_PUBLIC","IMAGE_SOURCE_TIMEOUT","IMAGE_SOURCE_TOO_LARGE","IMAGE_SOURCE_UNAVAILABLE","IMAGE_SOURCE_URL_INVALID","IMAGE_STORAGE_QUOTA_EXCEEDED","IMAGE_URL_INVALID","IMAGE_URL_MUST_BE_CANONICAL","INCORRECT_CVC","INITIAL_API_KEY_ALREADY_CREATED","INSUFFICIENT_AVAILABLE_BALANCE","INSUFFICIENT_FUNDS","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INTERVAL_REQUIRED","INVALID_ACTION","INVALID_ACTIONABLE","INVALID_ACTIVITY_TYPE","INVALID_ALLOCATION","INVALID_AMOUNT","INVALID_API_KEY","INVALID_API_VERSION","INVALID_APPLICATION_METHOD","INVALID_AUTHORIZATION_HEADER","INVALID_BALANCE_SOURCE_TYPE","INVALID_BEARER_TOKEN","INVALID_BILLING_ANCHOR_DAY","INVALID_BILLING_INTERVAL","INVALID_BILLING_SCHEDULE_OWNER","INVALID_BOOLEAN","INVALID_BOOTSTRAP_SCOPES","INVALID_BUNDLE_STATUS","INVALID_CALCULATION_BASIS","INVALID_CANCELLATION_REASON","INVALID_CAPTURE_AMOUNT","INVALID_CAPTURE_METHOD","INVALID_CASE_TYPE","INVALID_CATEGORIES","INVALID_CATEGORY_DESCRIPTION","INVALID_CATEGORY_HANDLE","INVALID_CATEGORY_NAME","INVALID_CATEGORY_STATUS","INVALID_CHANNEL","INVALID_CHARGE_TYPE","INVALID_CHARGE_VALUE","INVALID_CHECKOUT_SESSION","INVALID_CHECKOUT_SURFACE","INVALID_CODE","INVALID_COMPLETION_BEHAVIOR","INVALID_COMPONENT","INVALID_COMPONENTS","INVALID_COMPONENT_POSITION","INVALID_COMPONENT_QUANTITY","INVALID_COUNTRY","INVALID_CREATED_AFTER","INVALID_CREATED_BEFORE","INVALID_CREATED_RANGE","INVALID_CREDIT_NOTE_CORRECTION_TYPE","INVALID_CREDIT_NOTE_LINE","INVALID_CREDIT_NOTE_MEMO","INVALID_CREDIT_NOTE_REASON","INVALID_CREDIT_NOTE_STATUS","INVALID_CURRENCY","INVALID_CURSOR","INVALID_CUSTOMER_ACCOUNT_REQUEST","INVALID_CUSTOMER_SESSION","INVALID_DEFAULT_FOR_CURRENCY","INVALID_DELAY_DAYS_OVERRIDE","INVALID_DELIVERY_CONFIGURATION_STATUS","INVALID_DELIVERY_EVALUATION_STATUS","INVALID_DELIVERY_MODE","INVALID_DELIVERY_OPTION_DETAILS","INVALID_DELIVERY_OPTION_TYPE","INVALID_DELIVERY_PROFILE_ID","INVALID_DELIVERY_QUOTE_STATUS","INVALID_DELIVERY_STATUS","INVALID_DIGITAL_WALLET","INVALID_DISCOUNT","INVALID_DISCOUNT_CALCULATION_BASIS","INVALID_DISCOUNT_CLASS","INVALID_DISCOUNT_SCOPE","INVALID_DISPUTE_REQUEST","INVALID_DOMAIN_NAME","INVALID_DONATION_AMOUNT","INVALID_ENVIRONMENT_SELECTION","INVALID_EVENT_AT","INVALID_EVENT_TYPE","INVALID_EXCLUSIVITY_SELECTION","INVALID_EXPAND","INVALID_EXPECTED_VERSION","INVALID_EXPIRES_AT","INVALID_EXTERNAL_REFERENCE_ID","INVALID_FEEDBACK_KIND","INVALID_FEEDBACK_SHAPE","INVALID_FEEDBACK_SURFACE","INVALID_FIELD_TYPE","INVALID_FLAT_MONEY","INVALID_FLAT_TAX","INVALID_FULFILLMENT_BUYER_NOTIFICATION_BEHAVIOR","INVALID_FULFILLMENT_DETAILS","INVALID_FULFILLMENT_EVENT_TYPE","INVALID_FULFILLMENT_QUANTITY_EFFECT","INVALID_FULFILLMENT_REQUIREMENT","INVALID_FULFILLMENT_SHIPMENT_STATUS","INVALID_FULFILLMENT_STATUS","INVALID_FULFILLMENT_TYPE","INVALID_HAS_PLAN","INVALID_ID","INVALID_IDEMPOTENCY_KEY","INVALID_IMAGE_ALT","INVALID_IMAGE_EXTERNAL_REFERENCE_ID","INVALID_IMAGE_GALLERY","INVALID_INCLUDE","INVALID_INCLUDE_DELETED","INVALID_INTERVAL","INVALID_INTERVAL_END_AT","INVALID_INTERVAL_START_AT","INVALID_INVOICE","INVALID_INVOICE_COLLECTION","INVALID_INVOICE_COLLECTION_MODE","INVALID_INVOICE_DRAFT_SOURCE","INVALID_INVOICE_LATE_FEE_AMOUNT","INVALID_INVOICE_LATE_FEE_REASON","INVALID_INVOICE_LATE_FEE_SCHEDULE","INVALID_INVOICE_PAYMENT_DUE","INVALID_INVOICE_PAYMENT_DUE_TYPE","INVALID_INVOICE_PAYMENT_POLICY","INVALID_INVOICE_PAYMENT_TERM","INVALID_JSON","INVALID_LAUNCH_TOKEN","INVALID_LINE_ITEM","INVALID_LINE_ITEMS","INVALID_MAX_AMOUNT","INVALID_METADATA","INVALID_METADATA_KEY","INVALID_METHOD","INVALID_MINIMUM_BALANCE_AMOUNT","INVALID_MINIMUM_BALANCE_BY_CURRENCY","INVALID_MINIMUM_BALANCE_CURRENCY","INVALID_MIN_AMOUNT","INVALID_MODE","INVALID_MODIFIER","INVALID_MODIFIER_GROUP","INVALID_MODIFIER_GROUP_STATUS","INVALID_MODIFIER_GROUP_TYPE","INVALID_MODIFIER_SET","INVALID_MODIFIER_SET_ID","INVALID_MODIFIER_SET_STATUS","INVALID_MODIFIER_STATUS","INVALID_MONEY","INVALID_MONTHLY_PAYOUT_DAY","INVALID_NOTIFICATION_TYPE","INVALID_ONBOARDING_SESSION","INVALID_OPTIONS","INVALID_OPTION_POSITION","INVALID_OPTION_STATUS","INVALID_OPTION_VALUE","INVALID_OPTION_VALUE_POSITION","INVALID_OPTION_VALUE_STATUS","INVALID_ORDER_STATUS","INVALID_ORIGIN","INVALID_PACKAGING","INVALID_PAGE_SIZE","INVALID_PAGE_TOKEN","INVALID_PARTNER_APP","INVALID_PARTNER_TOKEN","INVALID_PAYMENTS","INVALID_PAYMENT_INTENT_STATE","INVALID_PAYMENT_LINK_CUSTOM_FIELD_TYPE","INVALID_PAYMENT_LINK_TYPE","INVALID_PAYMENT_METHOD_TYPE","INVALID_PAYMENT_OPTIONS","INVALID_PAYMENT_OPTION_RESOLVE_REQUEST","INVALID_PAYMENT_STATUS","INVALID_POLICY_COMBINATION","INVALID_PRODUCT_CREATE_SHAPE","INVALID_PRODUCT_TYPE","INVALID_QUERY","INVALID_QUERY_PARAMETER","INVALID_RANGE","INVALID_REASON","INVALID_RECIPIENT","INVALID_RECURRENCE_TYPE","INVALID_REDEMPTION_TYPE","INVALID_REFUND_ADJUSTMENT_APPLIES_TO","INVALID_REFUND_ADJUSTMENT_REASON_CODE","INVALID_REFUND_ADJUSTMENT_TYPE","INVALID_REFUND_METHOD","INVALID_REFUND_REASON","INVALID_REFUND_STATUS","INVALID_RELATED_OBJECT_ID","INVALID_RELATED_REQUEST_ID","INVALID_RELATED_RESOURCE_ID","INVALID_REPORT_INTERVAL","INVALID_REPORT_TYPE","INVALID_REQUEST","INVALID_REQUEST_BODY","INVALID_RESOURCE_ID","INVALID_RESOURCE_TYPE","INVALID_REWARD_SELECTION","INVALID_ROLE","INVALID_RULE_GROUP","INVALID_RULE_OPERATOR","INVALID_RULE_VALUE","INVALID_SANDBOX_ID","INVALID_SCOPE","INVALID_SHIPMENT_DIRECTION","INVALID_SHIPMENT_PACKAGE_STATUS","INVALID_SORT_BY","INVALID_SORT_DIRECTION","INVALID_SORT_FIELD","INVALID_SOURCE","INVALID_SOURCE_CONTEXT","INVALID_STACKING_MODE","INVALID_STATEMENT_DESCRIPTOR","INVALID_STATUS","INVALID_STATUS_BUCKET","INVALID_SUBSCRIPTION_PLAN_LINE_ITEM_ID","INVALID_SURFACE_ROUTE","INVALID_TAX_ADJUSTMENT_AUDIT_ACTOR_TYPE","INVALID_TAX_ADJUSTMENT_REASON_CODE","INVALID_TAX_CALCULATION_TYPE","INVALID_TAX_CATEGORY","INVALID_TAX_JURISDICTION","INVALID_TAX_MODE","INVALID_TAX_PERCENTAGE","INVALID_TAX_PRICE_MODE","INVALID_TAX_REFUND_MODE","INVALID_TAX_TYPE","INVALID_TEMPLATE","INVALID_TIMESTAMP","INVALID_TIMEZONE","INVALID_TIP","INVALID_TIP_AMOUNT","INVALID_TIP_PERCENT","INVALID_TOTALS","INVALID_TRANSACTION_PURPOSE","INVALID_UPDATED_AFTER","INVALID_UPDATED_BEFORE","INVALID_UPDATE_MASK","INVALID_VARIANT_STATUS","INVALID_VERIFICATION","INVALID_WEBHOOK_ENDPOINT","INVALID_WEBSITE_URL","INVALID_WEEKLY_PAYOUT_DAY","INVENTORY_ADJUSTMENT_NOT_FOUND","INVENTORY_ALLOCATION_POLICY_IN_USE","INVENTORY_CHANGED","INVENTORY_CONDITION_INVALID","INVENTORY_COUNT_CHANGED","INVENTORY_COUNT_NOT_FOUND","INVENTORY_COUNT_PHYSICAL_REVISION_CHANGED","INVENTORY_DEMAND_DUPLICATE","INVENTORY_DEMAND_INVALID","INVENTORY_EVENT_PROVENANCE_INVALID","INVENTORY_INSUFFICIENT","INVENTORY_ITEM_IN_USE","INVENTORY_ITEM_NOT_FOUND","INVENTORY_ITEM_UNAVAILABLE","INVENTORY_LEVEL_NOT_FOUND","INVENTORY_LOCATION_ALLOCATION_INACTIVE","INVENTORY_LOCATION_NOT_CONFIGURED","INVENTORY_MOVEMENT_NOT_FOUND","INVENTORY_POLICY_INVALID","INVENTORY_POLICY_NOT_FOUND","INVENTORY_QUANTITY_CONFLICT","INVENTORY_RECEIPT_CONFLICT","INVENTORY_RECEIPT_INVALID","INVENTORY_RECEIPT_NOT_FOUND","INVENTORY_RESERVATION_EXISTS","INVENTORY_RESERVATION_EXPIRED","INVENTORY_RESERVATION_NOT_FOUND","INVENTORY_RESERVATION_OWNER_MISMATCH","INVENTORY_ROUTING_SOURCE_INVALID","INVENTORY_ROUTING_SOURCE_REQUIRED","INVENTORY_ROUTING_TOO_COMPLEX","INVENTORY_ROUTING_UNAVAILABLE","INVENTORY_SHORTAGE","INVENTORY_SOURCE_SEQUENCE_CHANGED","INVENTORY_TRANSFER_ACTION_NOT_ALLOWED","INVENTORY_TRANSFER_CHANGED","INVENTORY_TRANSFER_INVALID","INVENTORY_TRANSFER_NOT_FOUND","INVENTORY_UNAVAILABLE","INVOICE_ACCESS_AUTH_UNAVAILABLE","INVOICE_AUTOPAY_PAYMENT_METHOD_REQUIRED","INVOICE_AUTOPAY_PAYMENT_METHOD_UNSUPPORTED","INVOICE_BALANCE_CHANGED","INVOICE_CHECKOUT_REPLACEMENT_NOT_ALLOWED","INVOICE_COLLECTION_BLOCKED","INVOICE_COLLECTION_CHANGED","INVOICE_COLLECTION_MODE_UNSUPPORTED","INVOICE_DRAFT_CHANGED","INVOICE_HAS_ISSUED_CREDIT_NOTE","INVOICE_ISSUE_IN_PROGRESS","INVOICE_LATE_FEE_NOT_COLLECTIBLE","INVOICE_LATE_FEE_NOT_DUE","INVOICE_LATE_FEE_NOT_FOUND","INVOICE_LATE_FEE_POLICY_REQUIRED","INVOICE_LINK_UNAVAILABLE","INVOICE_LOCKED_ORDER_FINANCIALS","INVOICE_NOT_COLLECTIBLE","INVOICE_NOT_CREDITABLE","INVOICE_NOT_DRAFT","INVOICE_NOT_FOUND","INVOICE_NOT_ISSUED","INVOICE_NOT_MARKABLE_UNCOLLECTIBLE","INVOICE_NOT_REVERSIBLE","INVOICE_NOT_VOIDABLE","INVOICE_PAYMENT_ALREADY_SETTLED","INVOICE_PAYMENT_ATTEMPT_ACTIVE","INVOICE_PAYMENT_FAILED","INVOICE_PAYMENT_METHOD_FROZEN","INVOICE_PAYMENT_OPTIONS_REQUIRED","INVOICE_PAYMENT_PROCESSING","INVOICE_PAYMENT_RESOLVING","INVOICE_PAYMENT_TERM_CHANGED","INVOICE_PAYMENT_TERM_IN_USE","INVOICE_PAYMENT_TERM_UNAVAILABLE","INVOICE_PDF_UNAVAILABLE","INVOICE_REMINDER_RATE_LIMITED","INVOICE_SCHEDULE_INVALID","INVOICE_SOURCE_CONFLICT","INVOICE_SOURCE_REQUIRED","INVOICE_TAX_SNAPSHOT_MISSING","INVOICE_TAX_SNAPSHOT_STALE","ITEMS_REQUIRED","LAST_NAME_REQUIRED","LATEST_REVISION","LAUNCH_TOKEN_SCOPE_MISMATCH","LINE_ITEM_INVALID_QUANTITY","LINE_ITEM_NAME_REQUIRED","LINE_ITEM_NAME_TOO_LONG","LINE_ITEM_NEGATIVE_PRICE","LINE_ITEM_PRICE_REQUIRED","LINE_ITEM_QUANTITY_TOO_LARGE","LINE_ITEM_REFUND_TARGET_AMBIGUOUS","LINE_ITEM_SOURCE_CONFLICT","LINE_ITEM_UNIT_PRICE_REQUIRED","LIST_IN_USE","LIST_RESERVED","LOCATION_CHANGED","LOCATION_CONFLICT","LOCATION_GEOGRAPHY_CHANGED","LOCATION_GEOGRAPHY_INVALID","LOCATION_INVALID","LOCATION_INVENTORY_CHANGED","LOCATION_IN_USE","LOCATION_NOT_ACTIVE","LOCATION_NOT_FOUND","MERCHANTS_UNAVAILABLE","MERCHANT_ACCESS_REQUIRED","MERCHANT_ACCOUNT_NOT_READY","MERCHANT_ACCOUNT_SESSION_ACCOUNT_SETUP_REPAIR_REQUIRED","MERCHANT_ACCOUNT_SESSION_ACCOUNT_SETUP_REQUIRED","MERCHANT_ACCOUNT_SESSION_ACCOUNT_SETUP_UNAVAILABLE","MERCHANT_ACCOUNT_SESSION_CONTROLLER_MISMATCH","MERCHANT_ACCOUNT_SESSION_INELIGIBLE","MERCHANT_ACCOUNT_SESSION_INVALID_COMPONENT","MERCHANT_ACCOUNT_SESSION_INVALID_LAUNCH_TOKEN","MERCHANT_ACCOUNT_SESSION_INVALID_POLICY_COMBINATION","MERCHANT_ACCOUNT_SESSION_LAUNCH_TOKEN_SCOPE_MISMATCH","MERCHANT_ACCOUNT_SESSION_POLICY_NOT_SUPPORTED_BY_COMPONENT","MERCHANT_ACCOUNT_SESSION_PREPARATION_FAILED","MERCHANT_ACCOUNT_SESSION_PROVIDER_GRANT_MISMATCH","MERCHANT_ACCOUNT_SESSION_TARGETED_REMEDIATION_UNAVAILABLE","MERCHANT_ACCOUNT_SESSION_UNAVAILABLE","MERCHANT_ACCOUNT_SESSION_UNMAPPABLE_REQUIREMENT_ID","MERCHANT_CHANGED","MERCHANT_CONTEXT_MISSING","MERCHANT_FINANCE_READ_FAILED","MERCHANT_NOT_LOADED","MERCHANT_ONBOARDING_REQUIRED","MERCHANT_READINESS_UNAVAILABLE","MERCHANT_SELECTION_REQUIRED","METADATA_KEY_TOO_LONG","METADATA_TOO_LARGE","METADATA_TOO_MANY_KEYS","METADATA_VALUE_TOO_LONG","METHOD_NOT_ALLOWED","ME_CUSTOMER_ID_FORBIDDEN","MINIMUM_BALANCE_CURRENCY_MISMATCH","MINIMUM_BALANCE_REQUIRED","MISSING_LINE_ITEMS","MISSING_REQUIRED_FIELD","MIXED_VARIANT_CURRENCIES","MODIFIERS_REQUIRED","MODIFIERS_UNAVAILABLE","MODIFIER_CURRENCY_MISMATCH","MODIFIER_DUPLICATE_SELECTION","MODIFIER_GROUP_CHANGED","MODIFIER_GROUP_REQUIRED","MODIFIER_METADATA_UNSUPPORTED","MODIFIER_OVERRIDE_INVALID","MODIFIER_QUANTITY_INVALID","MODIFIER_SELECTION_LIMIT_EXCEEDED","MODIFIER_SOURCE_UNSUPPORTED","MODIFIER_TEXT_INVALID","MODIFIER_UNAVAILABLE","MONEY_MOVEMENT_HISTORY_STATUS_INVALID","MONEY_MOVEMENT_OPERATION_BLOCKED","MONEY_MOVEMENT_PROVIDER_NOT_CONFIGURED","MONEY_MOVEMENT_PROVIDER_OPERATION_FAILED","MONTHLY_PAYOUT_DAYS_NOT_ALLOWED","MONTHLY_PAYOUT_DAYS_REQUIRED","MULTIPLE_IDENTITIES_FOUND","NAME_REQUIRED","NORMALIZED_IMAGE_TOO_LARGE","NOTE_TOO_LONG","NOTHING_TO_REFUND_FOR_TAX_BREAKDOWN","NO_DISCOUNTABLE_BALANCE","NO_FIELDS_TO_UPDATE","NULL_NOT_ALLOWED","OAUTH_UNAVAILABLE","ONBOARDING_CONTROLLER_VERSION_UNSUPPORTED","ONBOARDING_DIRECT_OWNER_REQUIRED","ONBOARDING_PARTNER_AUTH_UNSUPPORTED","ONBOARDING_PROFILE_PROVIDER_MANAGED","ONBOARDING_SESSION_REQUIRED","ONBOARDING_SESSION_TOKEN_FAILED","ONBOARDING_UNAVAILABLE","OPTIONS_REQUIRED","OPTION_REQUIRED","OPTION_VALUES_REQUIRED","OPTION_VALUE_REFERENCE_REQUIRED","OPTION_VALUE_REQUIRED","OPTION_VALUE_TOO_LONG","ORDERS_UNAVAILABLE","ORDER_ALREADY_CLOSED","ORDER_ALREADY_HAS_ACTIVE_INVOICE","ORDER_CHANGED_REFRESH_REQUIRED","ORDER_CHARGE_ID_REQUIRED","ORDER_CHARGE_NOT_FOUND","ORDER_CHARGE_TAX_INPUT_REQUIRED","ORDER_CLOSED","ORDER_COLLECTION_ALREADY_ACTIVE","ORDER_COLLECTION_IN_PROGRESS","ORDER_CONFLICT","ORDER_CUSTOMER_ALREADY_SET","ORDER_CUSTOMER_CHECKOUT_ACTIVE","ORDER_CUSTOMER_NOT_CLEARABLE","ORDER_CUSTOMER_NOT_UPDATABLE_AFTER_PAYMENT","ORDER_DELAYED_CAPTURE_SPLIT_PAYMENT_UNSUPPORTED","ORDER_DISCOUNT_NO_CHARGE_IDS","ORDER_DISCOUNT_NO_LINE_ITEM_IDS","ORDER_FINANCIAL_MUTATION_NOT_ALLOWED","ORDER_LINE_ITEM_ID_REQUIRED","ORDER_LINE_ITEM_TAX_INPUT_REQUIRED","ORDER_LINE_ITEM_VERSION_CONFLICT","ORDER_NOT_FOUND","ORDER_OWNED_PAYMENT_INTENT_REQUIRED","ORDER_PAYMENT_ATTEMPT_ACTIVE","ORDER_PAYMENT_FLOW_REQUIRED","ORDER_PAYMENT_INTENT_CREATE_IN_PROGRESS","ORDER_PAYMENT_LEG_ALREADY_SETTLED","ORDER_PERCENTAGE_TAX_FORBIDDEN","ORDER_RECEIPT_EMAIL_UNAVAILABLE","ORDER_RECEIPT_MERCHANT_MANAGED","ORDER_RECEIPT_NOT_AVAILABLE","ORDER_RECEIPT_RESEND_RATE_LIMITED","ORDER_RECONCILIATION_REQUIRED","ORDER_REFUNDED","ORDER_REQUIRED_FOR_TAX_BREAKDOWN_REFUND","ORDER_STATUS_NOT_CLOSABLE","ORDER_TAX_CALCULATION_FAILED","ORDER_TAX_LOCATION_INVALID","ORDER_TAX_LOCATION_REQUIRED","ORDER_TAX_NOT_READY","ORDER_TAX_NOT_UPDATABLE_AFTER_PAYMENT","ORDER_TAX_RATE_UNAVAILABLE","ORDER_TAX_UNSUPPORTED_COUNTRY","ORDER_TIP_MODEL_UNSUPPORTED","ORDER_TOTAL_BELOW_NET_COLLECTED","ORDER_UNAVAILABLE","ORG_SCOPE_RESOLUTION_FAILED","PACKAGE_ACTION_NOT_ALLOWED","PACKAGE_CHANGED","PACKAGE_PARENT_CHANGED","PACKAGE_REQUIRED","PARTNER_APP_INSTALL_NOT_FOUND","PARTNER_APP_MANAGEMENT_REQUIRES_LIVE_KEY","PARTNER_APP_NOT_FOUND","PARTNER_AUTH_UNSUPPORTED","PARTNER_TOKEN_VALIDATION_FAILED","PAYMENT_ACTION_EXPIRED","PAYMENT_ACTION_WINDOW_TOO_SHORT","PAYMENT_ATTEMPT_FROZEN","PAYMENT_ATTEMPT_ID_REQUIRED","PAYMENT_ATTEMPT_IN_PROGRESS","PAYMENT_ATTEMPT_MISMATCH","PAYMENT_ATTEMPT_NOT_RESUMABLE","PAYMENT_ATTEMPT_RESUME_CONFLICT","PAYMENT_ATTEMPT_STILL_PROCESSING","PAYMENT_BLOCKED","PAYMENT_CAPTURE_METHOD_NOT_ALLOWED","PAYMENT_CONFIRMATION_STATE_CHANGED","PAYMENT_FAILED","PAYMENT_INTENT_AMOUNT_INVALID","PAYMENT_INTENT_CAPTURE_METHOD_UNSUPPORTED","PAYMENT_INTENT_CHECKOUT_ALREADY_EXISTS","PAYMENT_INTENT_CHECKOUT_CHANGED","PAYMENT_INTENT_CHECKOUT_COMMERCE_CONFIG_UNSUPPORTED","PAYMENT_INTENT_CHECKOUT_SOURCE_CONFLICT","PAYMENT_INTENT_HAS_ORDER","PAYMENT_INTENT_NOT_COLLECTIBLE","PAYMENT_INTENT_NOT_FOUND","PAYMENT_INTENT_OPTIONS_IMMUTABLE","PAYMENT_INTENT_OPTIONS_REQUIRED","PAYMENT_INTENT_OPTIONS_UNSUPPORTED","PAYMENT_LEG_SELECTION_REQUIRED","PAYMENT_LINKS_UNAVAILABLE","PAYMENT_LINK_CHANGED","PAYMENT_LINK_CHANGED_RETRY","PAYMENT_LINK_FULFILLMENT_UNAVAILABLE","PAYMENT_LINK_NOT_FOUND","PAYMENT_LINK_RESOLUTION_CONTEXT_INVALID","PAYMENT_LINK_RESOLUTION_CONTEXT_REFRESH_REQUIRED","PAYMENT_LINK_RESOLUTION_CONTEXT_REQUIRED","PAYMENT_LINK_RESOLUTION_RATE_LIMITED","PAYMENT_LINK_RESOLUTION_REPLAY_UNAVAILABLE","PAYMENT_LINK_RESOLUTION_UNAVAILABLE","PAYMENT_METHOD_CUSTOMER_MISMATCH","PAYMENT_METHOD_DECLINED","PAYMENT_METHOD_DOMAINS_UNAVAILABLE","PAYMENT_METHOD_DOMAIN_ALREADY_EXISTS","PAYMENT_METHOD_DOMAIN_NOT_FOUND","PAYMENT_METHOD_DOMAIN_OPERATION_IN_PROGRESS","PAYMENT_METHOD_DOMAIN_REGISTRATION_FAILED","PAYMENT_METHOD_NOT_ACTIVE","PAYMENT_METHOD_NOT_READY","PAYMENT_METHOD_REQUIRED","PAYMENT_METHOD_TEMPORARILY_UNAVAILABLE","PAYMENT_METHOD_UNAVAILABLE","PAYMENT_NOT_COMPLETED","PAYMENT_NOT_REQUIRED","PAYMENT_OPERATION_IN_PROGRESS","PAYMENT_OPTIONS_REQUIRED","PAYMENT_OPTION_LIMIT_EXCEEDED","PAYMENT_OPTION_NOT_ALLOWED","PAYMENT_OPTION_NOT_READY","PAYMENT_OPTION_RESOLVE_FAILED","PAYMENT_PROCESSING_UNAVAILABLE","PAYMENT_RETURN_URL_INVALID","PAYMENT_RETURN_URL_REQUIRED","PAYMENT_SOURCE_CONFLICT","PAYMENT_SOURCE_NOT_ALLOWED","PAYMENT_SOURCE_OWNERSHIP_MISMATCH","PAYMENT_SOURCE_REQUIRED","PAYMENT_SOURCE_SELECTION_CONFLICT","PAYMENT_SOURCE_SELECTION_REQUIRED","PAYMENT_SOURCE_UNAVAILABLE","PAYMENT_START_SHAPE_CONFLICT","PAYOUT_DELAY_PROVIDER_CONTROLLED","PAYOUT_DESTINATION_NOT_FOUND","PAYOUT_DESTINATION_UPDATE_EMPTY","PAYOUT_ENTRIES_UNAVAILABLE","PAYOUT_FEE_NOT_DETERMINABLE","PAYOUT_NOT_CANCELABLE","PAYOUT_NOT_FOUND","PAYOUT_SETTINGS_MANAGED_EXTERNALLY","PAYOUT_SETTINGS_SNAPSHOT_UNAVAILABLE","PAYOUT_SETTINGS_UPDATE_EMPTY","PAYOUT_STATUS_NOT_CANCELABLE","PLAN_NOT_ACTIVE","POLICY_NOT_SUPPORTED_BY_COMPONENT","PROCESSING_ERROR","PROCESSING_FEE_PRICING_NOT_AUTHORIZED","PROCESSING_FEE_PRICING_UNAVAILABLE","PRODUCT_LINE_ITEM_SOURCE_UNSUPPORTED","PROFILE_RECONCILIATION_PENDING","PROFILE_UPDATE_STATUS_UNKNOWN","PROFILE_WRITE_LIVE_MODE_REQUIRED","PROMOTION_CONFLICT","PROMOTION_DECLINED","PROMOTION_FILTER_TARGET_CONFLICT","PROMOTION_ID_REQUIRED","PROMOTION_NOT_REDEEMABLE","PROMOTION_NO_ACTIVE_CODES","PROVIDER_ACCOUNT_CLEANUP_REQUIRED","PROVIDER_READINESS_UNAVAILABLE","PROVISIONING_FAILED","RANGE_REQUIRED","RATE_LIMIT_EXCEEDED","READ_ONLY_REASON","RECIPIENT_EMAIL_REQUIRED","REFUND_ADJUSTMENT_AMOUNT_MONEY_REQUIRED","REFUND_ADJUSTMENT_REASON_REQUIRED","REFUND_ADJUSTMENT_REFUND_AMOUNT_MONEY_REQUIRED","REFUND_INSUFFICIENT_AVAILABLE_BALANCE","REFUND_LINE_ITEM_ADJUSTMENT_ID_REQUIRED","REFUND_SUBMISSION_DEADLINE_EXPIRED","RELATED_OBJECT_ID_UNSUPPORTED_FOR_TYPE","RELATED_OBJECT_TYPE_REQUIRED","REPORTING_UNAVAILABLE","REPORT_DOWNLOAD_EXPIRED","REPORT_INTERVAL_INCOMPLETE","REPORT_INTERVAL_TOO_LARGE","REPORT_NOT_FOUND","REQUEST_BODY_NOT_ALLOWED","REQUEST_FAILED","REQUEST_TIMEOUT","RESERVED_FIELD_NOT_YET_SUPPORTED","RESERVED_METADATA_KEY","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","RESOURCE_TIMELINE_TOKEN_INVALID","RETURN_ACTION_NOT_ALLOWED","RETURN_COMPLETION_BLOCKED","RETURN_DECISION_SCOPE_REQUIRED","RETURN_DISPOSITION_QUANTITY_EXCEEDED","RETURN_FULFILLMENT_ALLOCATION_AMBIGUOUS","RETURN_INSPECTION_QUANTITY_EXCEEDED","RETURN_INVALID","RETURN_LINE_CANCELLATION_CONFLICT","RETURN_NOT_FOUND","RETURN_PAYMENT_INTENT_MISMATCH","RETURN_POLICY_CONFLICT","RETURN_RECEIPT_QUANTITY_EXCEEDED","RETURN_VALUE_EXCEEDED","RETURN_VERSION_CONFLICT","REVIEW_ALREADY_CLOSED","REVIEW_NOT_FOUND","REVIEW_RESOLUTION_IN_PROGRESS","RISK_CONTROL_CONFLICT","RISK_EVALUATION_UNAVAILABLE","RISK_LIST_ALIAS_ALREADY_EXISTS","RISK_RESOURCE_NOT_FOUND","ROUTE_NOT_FOUND","RULE_LIMIT_EXCEEDED","RULE_RESERVED","SANDBOXES_UNAVAILABLE","SANDBOX_ALREADY_EXISTS","SANDBOX_ARCHIVED","SANDBOX_ARCHIVE_FAILED","SANDBOX_BOOTSTRAP_FAILED","SANDBOX_CREATE_FAILED","SANDBOX_ID_NOT_ALLOWED","SANDBOX_ID_REQUIRED","SANDBOX_INACTIVE","SANDBOX_LIST_FAILED","SANDBOX_LOOKUP_FAILED","SANDBOX_MANAGEMENT_REQUIRES_LIVE_KEY","SANDBOX_NOT_ACCESSIBLE","SANDBOX_NOT_FOUND","SANDBOX_PLANE_UNAVAILABLE","SANDBOX_RESET_FAILED","SANDBOX_RESET_UNAVAILABLE","SANDBOX_SELECTION_FORBIDDEN","SANDBOX_SELECTION_REQUIRED","SCOPES_REQUIRED","SCOPE_NOT_ALLOWED","SCOPE_NOT_ALLOWED_FOR_KEY_MODE","SENSITIVE_IDEMPOTENCY_ENCRYPTION_INVALID","SENSITIVE_IDEMPOTENCY_ENCRYPTION_UNCONFIGURED","SENSITIVE_IDEMPOTENCY_RESULT_INVALID","SERVER_GENERATED_ID","SERVICE_CHARGE_DISCOUNT_NO_LINE_ITEM_IDS","SERVICE_CHARGE_DISCOUNT_REQUIRES_CHARGE_IDS","SERVICE_CHARGE_DISCOUNT_SCOPE_INVALID","SERVICE_UNAVAILABLE","SETTINGS_CONCURRENT_MODIFICATION","SETTINGS_UNAVAILABLE","SHIPMENT_CHANGED","SOURCE_CONTEXT_CONFLICT","STANDARD_PAYOUT_REQUIRES_MANUAL_SCHEDULE","STREAMING_UNAVAILABLE","SUBSCRIPTION_BILLING_SCHEDULE_REQUIRED","SUBSCRIPTION_BILLING_START_INVALID","SUBSCRIPTION_CANCELED","SUBSCRIPTION_EXTERNAL_BILLING_ANCHOR_NOT_ALLOWED","SUBSCRIPTION_IMPORT_PERIOD_NOT_CURRENT","SUBSCRIPTION_INITIATED_BY_INVALID","SUBSCRIPTION_NEXT_BILLING_AT_BEFORE_PERIOD_START","SUBSCRIPTION_NEXT_BILLING_AT_NOT_FUTURE","SUBSCRIPTION_NEXT_BILLING_AT_REQUIRED","SUBSCRIPTION_NEXT_BILLING_AT_TOO_FAR","SUBSCRIPTION_NOT_FOUND","SUBSCRIPTION_PAYMENT_RETRY_NOT_ALLOWED","SUBSCRIPTION_PLAN_NOT_FOUND","SUBSCRIPTION_SCHEDULE_CLEAR_NOT_ALLOWED","SUBSCRIPTION_SCHEDULE_MUTATION_NOT_ALLOWED","SUBSCRIPTION_SERVICE_LOCATION_INVALID","SUBSCRIPTION_STARTS_AT_NOT_FUTURE","SUBSCRIPTION_STARTS_AT_TRIAL_CONFLICT","SUBSCRIPTION_START_OVERRIDE_NOT_ALLOWED","TARGETED_REMEDIATION_UNAVAILABLE","TAX_BREAKDOWN_ID_REQUIRED","TAX_BREAKDOWN_NOT_ORDER_SCOPED_FLAT","TAX_BREAKDOWN_REFUND_MONEY_REQUIRED","TAX_BREAKDOWN_TARGETS_EXCEED_REFUND_AMOUNT","TAX_CALCULATION_REQUIRED","TAX_INPUT_CONFLICT","TAX_MODE_MISMATCH","TIP_ALLOCATION_CAPACITY_EXCEEDED","TIP_CURRENCY_MISMATCH","TIP_LIMIT_EXCEEDED","TOO_MANY_LINE_ITEMS","TOO_MANY_PENDING_REPORTS","TRANSACTION_PURPOSE_NOT_APPLICABLE","TRANSACTION_PURPOSE_REQUIRED","UNKNOWN_BUNDLE_COMPONENT","UNKNOWN_CLIENT_OPTION_VALUE","UNKNOWN_FIELD","UNKNOWN_OPTION","UNKNOWN_OPTION_VALUE","UNKNOWN_SCOPE","UNMAPPABLE_REQUIREMENT_ID","UNSAFE_FEEDBACK_CONTENT","UNSUPPORTED_APPLICATION_TYPE","UNSUPPORTED_CONTENT_TYPE","UNSUPPORTED_CURRENCY","UNSUPPORTED_PRODUCT_FIELD","UNSUPPORTED_QUERY_PARAM","UNSUPPORTED_RESOURCE_TYPE","UPDATE_MASK_REQUIRED","USE_CANCEL_SUBSCRIPTION","VALIDATION_ERROR","VALUE_REQUIRED","VARIANTS_REQUIRED","VARIANT_IN_ACTIVE_BUNDLE","VARIANT_NOT_SELLABLE","VARIANT_OPTION_COMBINATION_ALREADY_EXISTS","VERIFICATION_ALREADY_USED","VERIFICATION_CODE_FAILED","VERIFICATION_EMAIL_FAILED","VERIFICATION_TOKEN_FAILED","WEBHOOKS_UNAVAILABLE","WEBHOOK_DELIVERY_IN_FLIGHT","WEBHOOK_DELIVERY_UNAVAILABLE","WEBHOOK_ENDPOINT_NOT_ACTIVE","WEBHOOK_EVENT_PAYLOAD_EXPIRED","WEBHOOK_STREAM_CONNECTION_LIMIT","WEBHOOK_STREAM_LIMITER_UNAVAILABLE","WEBHOOK_STREAM_NOTIFIER_UNAVAILABLE","WEEKLY_PAYOUT_DAYS_NOT_ALLOWED","WEEKLY_PAYOUT_DAYS_REQUIRED"],"type":"string","x-enum-descriptions":["ACCOUNT SETUP CONFIGURATION CONFLICT.","ACCOUNT SETUP REPAIR REQUIRED.","ACCOUNT SETUP REQUIRED.","ACCOUNT SETUP UNAVAILABLE.","ACTIVE BUNDLE COMPONENTS IMMUTABLE.","ACTIVE DEMO SESSION EXISTS.","ACTIVE OPTIONS REQUIRED.","ACTIVE OPTION SELECTOR COLLAPSE.","ACTIVE VARIANTS REQUIRE OPTION BACKFILL.","AFFIRM REFUND RETRY NOT ALLOWED.","AMBIGUOUS AUTH.","AMOUNT MONEY CURRENCY REQUIRED.","AMOUNT MONEY REQUIRED.","API KEYS UNAVAILABLE.","API KEY DATA INVALID.","API KEY EXPIRED.","API KEY MODE MISMATCH.","API KEY NOT FOUND.","API KEY REQUIRED.","API KEY REVOKED.","API KEY SANDBOX UNAVAILABLE.","API KEY SCOPE INVALID.","API KEY SCOPE UNSUPPORTED.","API VERSION CHANGED.","API VERSION RETIRED.","APPLICATION METHOD REQUIRED.","ARCHIVED CATEGORY.","AUTHENTICATION FAILED.","AUTHENTICATION REQUIRED.","AUTHORIZATION FAILED.","AUTH CONTEXT MISSING.","AUTH REQUIRED.","AUTH UNAVAILABLE.","AUTH VALIDATION FAILED.","AUTOMATIC PAYOUT NOT CANCELABLE.","AUTOMATIC TAX COMPONENTS FORBIDDEN.","AUTOMATIC TAX EXEMPTION UNSUPPORTED.","AUTOMATIC TAX INVOICE INSTALLMENTS UNSUPPORTED.","AUTOMATIC TAX MULTIPLE DESTINATIONS.","AUTOMATIC TAX MULTIPLE ORIGINS.","AUTOMATIC TAX PARTIAL PAYMENT UNSUPPORTED.","AUTOMATIC TAX POST TAX DISCOUNT UNSUPPORTED.","AVAILABLE MERCHANT.","BALANCE SNAPSHOT UNAVAILABLE.","BALANCE SOURCE TYPE REQUIRED.","BALANCE TRANSACTION NOT FOUND.","BANK ACCOUNT CLOSED.","BANK ACCOUNT NOT FOUND.","BANK ACCOUNT RESTRICTED.","BANK DEBIT LIMIT EXCEEDED.","BANK DEBIT NOT AUTHORIZED.","BUNDLE COMPONENTS REQUIRED.","BUNDLE COMPONENT PRODUCT NOT ACTIVE.","BUNDLE COMPONENT VARIANT NOT ACTIVE.","BUNDLE NOT SELLABLE.","BUYER FULFILLMENT CORRELATION FORBIDDEN.","BUYER INVOICE CREDENTIAL INVALID.","BUYER INVOICE CREDENTIAL REQUIRED.","CANNOT PAUSE.","CANNOT RESUME.","CANNOT RESUME INITIAL PAYMENT PENDING.","CANNOT RESUME PAST DUE PAYMENT REQUIRED.","CAPABILITIES UNAVAILABLE.","CAPABILITY SET UNSUPPORTED.","CAPABILITY SNAPSHOT UNAVAILABLE.","CAPTURE AMOUNT EXCEEDS CAPTURABLE.","CAPTURE CURRENCY MISMATCH.","CARD DECLINED.","CATALOG INVENTORY RELATIONSHIP INVALID.","CATALOG LINE ITEM CURRENCY CHANGED.","CATALOG LINE ITEM FIELDS READ ONLY.","CATALOG LINE ITEM SOURCE CHANGED.","CATALOG MODIFIERS REQUIRED.","CATEGORY HANDLE EXISTS.","CATEGORY MODIFIED.","CATEGORY REFERENCED.","CATEGORY TARGETED.","CHALLENGE FAILED.","CHALLENGE REQUIRED.","CHALLENGE TOKEN INVALID.","CHARGE NAME REQUIRED.","CHARGE TYPE REQUIRED.","CHECKOUT CREDENTIAL CHANGED.","CHECKOUT DISCOUNT ID NOT ALLOWED.","CHECKOUT DISCOUNT NOT REMOVABLE.","CHECKOUT LAUNCH TOKEN RESTRICTED.","CHECKOUT MANUAL DISCOUNT NOT ALLOWED.","CHECKOUT ORDER UPDATE FIELD NOT ALLOWED.","CHECKOUT PAYMENT RESOLVING.","CHECKOUT RECOVERY ATTEMPT MISMATCH.","CHECKOUT RECOVERY RESTRICTED.","CHECKOUT REPLACEMENT REQUIRES ORDER.","CHECKOUT SESSIONS UNAVAILABLE.","CHECKOUT SESSION ALREADY EXISTS.","CHECKOUT SESSION AUTH REQUIRED.","CHECKOUT SESSION AUTH UNAVAILABLE.","CHECKOUT SESSION CURRENT CHANGED.","CHECKOUT SESSION LOOKUP FAILED.","CHECKOUT SESSION MODIFIERS READ ONLY.","CHECKOUT SESSION MODIFIER FIELDS ONLY.","CHECKOUT SESSION MODIFIER UPDATE LINE ITEM MISSING.","CHECKOUT SESSION MODIFIER UPDATE MISSING ORDER.","CHECKOUT SESSION NOT FOUND.","CHECKOUT SESSION NOT OPEN.","CHECKOUT SESSION ORDER MISMATCH.","CHECKOUT SESSION PAYMENT REQUIRED.","CHECKOUT SESSION REQUIRED.","CHECKOUT SESSION REVISION CONFLICT.","CHECKOUT SESSION REVISION REQUIRED.","CHECKOUT SESSION REVISION UNAVAILABLE.","CHECKOUT SESSION SCOPE MISMATCH.","CHECKOUT SESSION SECRET REQUIRED.","CHECKOUT TAX CALCULATION LIMIT REACHED.","CHECKOUT TIPPING DISABLED.","CHECKOUT TIP NOT ALLOWED.","CLERK EMAIL MISSING.","CLERK EMAIL VERIFY FAILED.","CLERK USER CREATE FAILED.","CLERK USER LOOKUP FAILED.","CODE TOO LONG.","COMPONENT REQUIRED.","CONCURRENT MODIFICATION.","CONFIRMATION RETURN URL INVALID.","CONFIRMATION RETURN URL NOT ALLOWED.","CONFIRMATION RETURN URL REQUIRED.","CONTEXT NOT FOUND.","COUNTRY NOT SUPPORTED.","CREATE ORDER LINE ITEM DISCOUNT UNSUPPORTED.","CREDIT NOTE ALLOCATION ALREADY REVERSED.","CREDIT NOTE ALLOCATION EXCEEDS BALANCE.","CREDIT NOTE AMOUNT EXCEEDS CREDITABLE.","CREDIT NOTE CHANGED.","CREDIT NOTE CURRENCY MISMATCH.","CREDIT NOTE HAS ALLOCATIONS.","CREDIT NOTE ISSUE IN PROGRESS.","CREDIT NOTE NOT DRAFT.","CREDIT NOTE NOT ISSUED.","CREDIT NOTE REFUND EXCEEDS BALANCE.","CREDIT NOTE REFUND INVALID.","CURRENCY MISMATCH.","CURSOR MISMATCH.","CUSTOMER ACCOUNTS UNAVAILABLE.","CUSTOMER ACCOUNT RESOURCE NOT FOUND.","CUSTOMER DELETION BLOCKED.","CUSTOMER DELETION PROCESSING.","CUSTOMER EMAIL ALREADY USED.","CUSTOMER SESSIONS UNAVAILABLE.","CUSTOMER SESSION EXPIRED.","CUSTOMER SESSION NOT FOUND.","CUSTOMER SESSION REFRESH EXPIRED.","CUSTOMER SESSION REFRESH REUSED.","CUSTOMER SESSION REQUIRED.","CUSTOM DOMAIN NOT VERIFIED.","DAILY LIMIT EXCEEDED.","DANGLING EXPANSION REFERENCE.","DEFAULT ENVIRONMENT REQUIRED.","DEFAULT PAYOUT DESTINATIONS MANAGED EXTERNALLY.","DEFAULT PAYOUT DESTINATION INVALID.","DEFAULT PAYOUT DESTINATION REPLACEMENT REQUIRED.","DEFAULT PAYOUT DESTINATION REQUIRED.","DEFAULT SANDBOX CANNOT BE ARCHIVED.","DEFAULT SANDBOX CANNOT BE RESET.","DEFAULT VARIANT REQUIRED.","DELIVERY CALCULATION EXPIRED.","DELIVERY CALLER RATES UNAVAILABLE TO BUYER.","DELIVERY COMMERCE TREATMENT UNSUPPORTED.","DELIVERY CONFIGURATION INVALID.","DELIVERY DEPENDENCY REVOKED.","DELIVERY DESTINATION ADDRESS INCOMPLETE.","DELIVERY DESTINATION ADDRESS REQUIRED.","DELIVERY DESTINATION CONTROLLED BY SELECTION.","DELIVERY DESTINATION COUNTRY INVALID.","DELIVERY DESTINATION FIELD TOO LONG.","DELIVERY DESTINATION FROZEN.","DELIVERY DESTINATION INVALID.","DELIVERY DESTINATION NOT APPLICABLE.","DELIVERY DESTINATION UPDATE CONFLICT.","DELIVERY ELIGIBILITY CONTEXT CHANGED.","DELIVERY EXPECTED SELECTION REQUIRED.","DELIVERY EXPECTED VERSION INVALID.","DELIVERY EXPECTED VERSION REQUIRED.","DELIVERY EXTERNAL REFERENCE REUSED.","DELIVERY FIELD NOT SUPPORTED.","DELIVERY FIELD REQUIRED.","DELIVERY GROUPING UNSUPPORTED.","DELIVERY MERCHANT INPUT REQUIRED.","DELIVERY METHODS NOT APPLICABLE.","DELIVERY METHOD SERVICE UNAVAILABLE.","DELIVERY OPTION ALREADY SELECTED.","DELIVERY OPTION EXPIRED.","DELIVERY OPTION NOT IN CHOICE GROUP.","DELIVERY PICKUP AVAILABILITY CHANGED.","DELIVERY PICKUP AVAILABILITY INVALID.","DELIVERY PICKUP AVAILABILITY UNAVAILABLE.","DELIVERY PICKUP LOCATION UNAVAILABLE.","DELIVERY PREVIEW INVALID.","DELIVERY PREVIEW METHOD TYPES INCOMPATIBLE.","DELIVERY PREVIEW REQUIRES CHECKOUT.","DELIVERY PREVIEW UNAVAILABLE.","DELIVERY PROFILE NOT APPLICABLE.","DELIVERY QUOTE BASIS INVALID.","DELIVERY QUOTE EXPIRED.","DELIVERY QUOTE INCOMPLETE.","DELIVERY QUOTE INPUT CHANGED.","DELIVERY QUOTE INVALID.","DELIVERY QUOTE REVOKED.","DELIVERY QUOTE STALE.","DELIVERY QUOTE UNAVAILABLE.","DELIVERY REQUEST INVALID.","DELIVERY RESOURCE HAS DEPENDENCIES.","DELIVERY RESOURCE NOT FOUND.","DELIVERY RESOURCE VERSION CONFLICT.","DELIVERY SELECTION CHANGED.","DELIVERY SELECTION EXPIRED.","DELIVERY SELECTION INCOMPLETE.","DELIVERY SELECTION NOT MUTABLE AFTER PAYMENT.","DELIVERY SELECTION REPLACEMENT LIMIT.","DELIVERY SELECTION UNAVAILABLE.","DELIVERY SERVICE UNAVAILABLE.","DELIVERY STATE CONFLICT.","DELIVERY STATUS COMBINATION INVALID.","DELIVERY STATUS INVALID.","DELIVERY WINDOW EXPIRED.","DELIVERY WINDOW INVALID.","DEMO SESSIONS UNAVAILABLE.","DEMO SESSION ROUTE NOT ALLOWED.","DEMO SESSION SECRET REPLAY EXPIRED.","DEVELOPER MANAGEMENT REQUIRES LIVE KEY.","DISCOUNT AMOUNT INVALID.","DISCOUNT REQUIRED.","DISPUTES UNAVAILABLE.","DISPUTE NOT FOUND.","DUPLICATE BUNDLE COMPONENT ID.","DUPLICATE CLIENT OPTION KEY.","DUPLICATE CLIENT VALUE KEY.","DUPLICATE CODE.","DUPLICATE COMPONENT VARIANT.","DUPLICATE IMAGE EXTERNAL REFERENCE ID.","DUPLICATE IMAGE SOURCE.","DUPLICATE INVOICE LINE.","DUPLICATE OPTION.","DUPLICATE OPTION NAME.","DUPLICATE OPTION VALUE.","DUPLICATE ORDER CHARGE ID.","DUPLICATE SCOPE.","DUPLICATE TAX BREAKDOWN REFUND.","DUPLICATE TAX COMPONENT.","DUPLICATE VALUE.","EMAIL ALREADY LINKED.","EMAIL CHANGE CONFIRMATION EXPIRED.","EMAIL CHANGE CONFIRMATION INVALID.","EMAIL CHANGE DELIVERY FAILED.","EMAIL CHANGE RATE LIMITED.","EMAIL REQUIRED.","EMBEDDED PAYMENT RETURN URL REQUIRED.","EMPTY UPDATE.","ENVIRONMENT GRANT NOT FOUND.","ENVIRONMENT LOOKUP FAILED.","ENVIRONMENT LOOKUP UNAVAILABLE.","ENVIRONMENT REQUIRED.","ENVIRONMENT SELECTION FORBIDDEN.","EXACTLY ONE REQUIRED.","EXPANSION DEPENDENCY UNAVAILABLE.","EXPANSION LIMIT EXCEEDED.","EXPANSION RESOLUTION FAILED.","EXPECTED VERSION REQUIRED.","EXPIRED CARD.","EXTERNAL API KEY REQUIRED.","EXTERNAL IMAGE NOT ALLOWED.","EXTERNAL TAX COMPONENTS REQUIRED.","FEEDBACK REPORTS UNAVAILABLE.","FEEDBACK REPORT NOT FOUND.","FIELD NOT ALLOWED FOR CALLER.","FIELD NOT UPDATABLE.","FIELD REQUIRED.","FIRST NAME REQUIRED.","FLAT TAX PAYMENT ATTRIBUTION UNAVAILABLE.","FLAT TAX PRICE MODE INVALID.","FLAT TAX REFUND MUST BE FULL.","FLAT TAX REFUND STATE INVALID.","FLAT TAX SCOPE INVALID.","FRAUD WARNING NOT FOUND.","FULFILLMENT ACTION NOT ALLOWED.","FULFILLMENT APPROVAL REQUIRED.","FULFILLMENT BUNDLE UNSUPPORTED.","FULFILLMENT CHANGED.","FULFILLMENT COMPLETED.","FULFILLMENT COMPLETED DETAILS REPLACEMENT.","FULFILLMENT COMPLETION TIMESTAMP CONFLICT.","FULFILLMENT CONFIGURATION ACTION REQUIRED.","FULFILLMENT EVENT SUBJECT INVALID.","FULFILLMENT PROFILE REQUIRED.","FULFILLMENT PROFILE REVISION UNUSABLE.","FULFILLMENT PROFILE UNAVAILABLE.","FULFILLMENT QUANTITY EFFECT REQUIRED.","FULFILLMENT REASON INVALID.","FULFILLMENT REQUIREMENT REQUIRED.","FULFILLMENT SCHEDULE NOT ALLOWED.","FULFILLMENT SCHEDULE REQUIRED.","FULFILLMENT SELECTION REQUIRED.","FULFILLMENT STATUS REASON TOO LONG.","FULFILLMENT TERMINAL.","FULFILLMENT TYPE REQUIRED.","HOSTED INSTALL UNAVAILABLE.","IDEMPOTENCY CLEAR FAILED.","IDEMPOTENCY KEY IN PROGRESS.","IDEMPOTENCY KEY REQUIRED.","IDEMPOTENCY KEY REUSED.","IDEMPOTENCY KEY TOO LONG.","IDEMPOTENCY LOAD FAILED.","IDEMPOTENCY PERSIST FAILED.","IDEMPOTENCY RECORD INVALID.","IDEMPOTENCY RECOVERY REQUIRED.","IDEMPOTENCY REQUEST IN PROGRESS.","IDENTITY RESOLUTION FAILED.","IMAGE ANIMATION UNSUPPORTED.","IMAGE ASSET NOT ATTACHABLE.","IMAGE ASSET NOT FOUND.","IMAGE DIMENSIONS EXCEEDED.","IMAGE FORMAT UNSUPPORTED.","IMAGE GALLERY LIMIT EXCEEDED.","IMAGE INGESTION COUNT EXCEEDED.","IMAGE INGESTION EXPIRED.","IMAGE INGESTION IN PROGRESS.","IMAGE INGESTION RESTART REQUIRED.","IMAGE NOT ATTACHABLE.","IMAGE OWNER NOT MUTABLE.","IMAGE PIXEL BUDGET EXCEEDED.","IMAGE PROCESSING CAPACITY EXCEEDED.","IMAGE PROCESSING FAILED.","IMAGE PROCESSING TIMEOUT.","IMAGE REVISION MISMATCH.","IMAGE SOURCE FETCH FAILED.","IMAGE SOURCE NOT PUBLIC.","IMAGE SOURCE TIMEOUT.","IMAGE SOURCE TOO LARGE.","IMAGE SOURCE UNAVAILABLE.","IMAGE SOURCE URL INVALID.","IMAGE STORAGE QUOTA EXCEEDED.","IMAGE URL INVALID.","IMAGE URL MUST BE CANONICAL.","INCORRECT CVC.","INITIAL API KEY ALREADY CREATED.","INSUFFICIENT AVAILABLE BALANCE.","INSUFFICIENT FUNDS.","INSUFFICIENT SCOPE.","INTERNAL ERROR.","INTERVAL REQUIRED.","INVALID ACTION.","INVALID ACTIONABLE.","INVALID ACTIVITY TYPE.","INVALID ALLOCATION.","INVALID AMOUNT.","INVALID API KEY.","INVALID API VERSION.","INVALID APPLICATION METHOD.","INVALID AUTHORIZATION HEADER.","INVALID BALANCE SOURCE TYPE.","INVALID BEARER TOKEN.","INVALID BILLING ANCHOR DAY.","INVALID BILLING INTERVAL.","INVALID BILLING SCHEDULE OWNER.","INVALID BOOLEAN.","INVALID BOOTSTRAP SCOPES.","INVALID BUNDLE STATUS.","INVALID CALCULATION BASIS.","INVALID CANCELLATION REASON.","INVALID CAPTURE AMOUNT.","INVALID CAPTURE METHOD.","INVALID CASE TYPE.","INVALID CATEGORIES.","INVALID CATEGORY DESCRIPTION.","INVALID CATEGORY HANDLE.","INVALID CATEGORY NAME.","INVALID CATEGORY STATUS.","INVALID CHANNEL.","INVALID CHARGE TYPE.","INVALID CHARGE VALUE.","INVALID CHECKOUT SESSION.","INVALID CHECKOUT SURFACE.","INVALID CODE.","INVALID COMPLETION BEHAVIOR.","INVALID COMPONENT.","INVALID COMPONENTS.","INVALID COMPONENT POSITION.","INVALID COMPONENT QUANTITY.","INVALID COUNTRY.","INVALID CREATED AFTER.","INVALID CREATED BEFORE.","INVALID CREATED RANGE.","INVALID CREDIT NOTE CORRECTION TYPE.","INVALID CREDIT NOTE LINE.","INVALID CREDIT NOTE MEMO.","INVALID CREDIT NOTE REASON.","INVALID CREDIT NOTE STATUS.","INVALID CURRENCY.","INVALID CURSOR.","INVALID CUSTOMER ACCOUNT REQUEST.","INVALID CUSTOMER SESSION.","INVALID DEFAULT FOR CURRENCY.","INVALID DELAY DAYS OVERRIDE.","INVALID DELIVERY CONFIGURATION STATUS.","INVALID DELIVERY EVALUATION STATUS.","INVALID DELIVERY MODE.","INVALID DELIVERY OPTION DETAILS.","INVALID DELIVERY OPTION TYPE.","INVALID DELIVERY PROFILE ID.","INVALID DELIVERY QUOTE STATUS.","INVALID DELIVERY STATUS.","INVALID DIGITAL WALLET.","INVALID DISCOUNT.","INVALID DISCOUNT CALCULATION BASIS.","INVALID DISCOUNT CLASS.","INVALID DISCOUNT SCOPE.","INVALID DISPUTE REQUEST.","INVALID DOMAIN NAME.","INVALID DONATION AMOUNT.","INVALID ENVIRONMENT SELECTION.","INVALID EVENT AT.","INVALID EVENT TYPE.","INVALID EXCLUSIVITY SELECTION.","INVALID EXPAND.","INVALID EXPECTED VERSION.","INVALID EXPIRES AT.","INVALID EXTERNAL REFERENCE ID.","INVALID FEEDBACK KIND.","INVALID FEEDBACK SHAPE.","INVALID FEEDBACK SURFACE.","INVALID FIELD TYPE.","INVALID FLAT MONEY.","INVALID FLAT TAX.","INVALID FULFILLMENT BUYER NOTIFICATION BEHAVIOR.","INVALID FULFILLMENT DETAILS.","INVALID FULFILLMENT EVENT TYPE.","INVALID FULFILLMENT QUANTITY EFFECT.","INVALID FULFILLMENT REQUIREMENT.","INVALID FULFILLMENT SHIPMENT STATUS.","INVALID FULFILLMENT STATUS.","INVALID FULFILLMENT TYPE.","INVALID HAS PLAN.","INVALID ID.","INVALID IDEMPOTENCY KEY.","INVALID IMAGE ALT.","INVALID IMAGE EXTERNAL REFERENCE ID.","INVALID IMAGE GALLERY.","INVALID INCLUDE.","INVALID INCLUDE DELETED.","INVALID INTERVAL.","INVALID INTERVAL END AT.","INVALID INTERVAL START AT.","INVALID INVOICE.","INVALID INVOICE COLLECTION.","INVALID INVOICE COLLECTION MODE.","INVALID INVOICE DRAFT SOURCE.","INVALID INVOICE LATE FEE AMOUNT.","INVALID INVOICE LATE FEE REASON.","INVALID INVOICE LATE FEE SCHEDULE.","INVALID INVOICE PAYMENT DUE.","INVALID INVOICE PAYMENT DUE TYPE.","INVALID INVOICE PAYMENT POLICY.","INVALID INVOICE PAYMENT TERM.","INVALID JSON.","INVALID LAUNCH TOKEN.","INVALID LINE ITEM.","INVALID LINE ITEMS.","INVALID MAX AMOUNT.","INVALID METADATA.","INVALID METADATA KEY.","INVALID METHOD.","INVALID MINIMUM BALANCE AMOUNT.","INVALID MINIMUM BALANCE BY CURRENCY.","INVALID MINIMUM BALANCE CURRENCY.","INVALID MIN AMOUNT.","INVALID MODE.","INVALID MODIFIER.","INVALID MODIFIER GROUP.","INVALID MODIFIER GROUP STATUS.","INVALID MODIFIER GROUP TYPE.","INVALID MODIFIER SET.","INVALID MODIFIER SET ID.","INVALID MODIFIER SET STATUS.","INVALID MODIFIER STATUS.","INVALID MONEY.","INVALID MONTHLY PAYOUT DAY.","INVALID NOTIFICATION TYPE.","INVALID ONBOARDING SESSION.","INVALID OPTIONS.","INVALID OPTION POSITION.","INVALID OPTION STATUS.","INVALID OPTION VALUE.","INVALID OPTION VALUE POSITION.","INVALID OPTION VALUE STATUS.","INVALID ORDER STATUS.","INVALID ORIGIN.","INVALID PACKAGING.","INVALID PAGE SIZE.","INVALID PAGE TOKEN.","INVALID PARTNER APP.","INVALID PARTNER TOKEN.","INVALID PAYMENTS.","INVALID PAYMENT INTENT STATE.","INVALID PAYMENT LINK CUSTOM FIELD TYPE.","INVALID PAYMENT LINK TYPE.","INVALID PAYMENT METHOD TYPE.","INVALID PAYMENT OPTIONS.","INVALID PAYMENT OPTION RESOLVE REQUEST.","INVALID PAYMENT STATUS.","INVALID POLICY COMBINATION.","INVALID PRODUCT CREATE SHAPE.","INVALID PRODUCT TYPE.","INVALID QUERY.","INVALID QUERY PARAMETER.","INVALID RANGE.","INVALID REASON.","INVALID RECIPIENT.","INVALID RECURRENCE TYPE.","INVALID REDEMPTION TYPE.","INVALID REFUND ADJUSTMENT APPLIES TO.","INVALID REFUND ADJUSTMENT REASON CODE.","INVALID REFUND ADJUSTMENT TYPE.","INVALID REFUND METHOD.","INVALID REFUND REASON.","INVALID REFUND STATUS.","INVALID RELATED OBJECT ID.","INVALID RELATED REQUEST ID.","INVALID RELATED RESOURCE ID.","INVALID REPORT INTERVAL.","INVALID REPORT TYPE.","INVALID REQUEST.","INVALID REQUEST BODY.","INVALID RESOURCE ID.","INVALID RESOURCE TYPE.","INVALID REWARD SELECTION.","INVALID ROLE.","INVALID RULE GROUP.","INVALID RULE OPERATOR.","INVALID RULE VALUE.","INVALID SANDBOX ID.","INVALID SCOPE.","INVALID SHIPMENT DIRECTION.","INVALID SHIPMENT PACKAGE STATUS.","INVALID SORT BY.","INVALID SORT DIRECTION.","INVALID SORT FIELD.","INVALID SOURCE.","INVALID SOURCE CONTEXT.","INVALID STACKING MODE.","INVALID STATEMENT DESCRIPTOR.","INVALID STATUS.","INVALID STATUS BUCKET.","INVALID SUBSCRIPTION PLAN LINE ITEM ID.","INVALID SURFACE ROUTE.","INVALID TAX ADJUSTMENT AUDIT ACTOR TYPE.","INVALID TAX ADJUSTMENT REASON CODE.","INVALID TAX CALCULATION TYPE.","INVALID TAX CATEGORY.","INVALID TAX JURISDICTION.","INVALID TAX MODE.","INVALID TAX PERCENTAGE.","INVALID TAX PRICE MODE.","INVALID TAX REFUND MODE.","INVALID TAX TYPE.","INVALID TEMPLATE.","INVALID TIMESTAMP.","INVALID TIMEZONE.","INVALID TIP.","INVALID TIP AMOUNT.","INVALID TIP PERCENT.","INVALID TOTALS.","INVALID TRANSACTION PURPOSE.","INVALID UPDATED AFTER.","INVALID UPDATED BEFORE.","INVALID UPDATE MASK.","INVALID VARIANT STATUS.","INVALID VERIFICATION.","INVALID WEBHOOK ENDPOINT.","INVALID WEBSITE URL.","INVALID WEEKLY PAYOUT DAY.","INVENTORY ADJUSTMENT NOT FOUND.","INVENTORY ALLOCATION POLICY IN USE.","INVENTORY CHANGED.","INVENTORY CONDITION INVALID.","INVENTORY COUNT CHANGED.","INVENTORY COUNT NOT FOUND.","INVENTORY COUNT PHYSICAL REVISION CHANGED.","INVENTORY DEMAND DUPLICATE.","INVENTORY DEMAND INVALID.","INVENTORY EVENT PROVENANCE INVALID.","INVENTORY INSUFFICIENT.","INVENTORY ITEM IN USE.","INVENTORY ITEM NOT FOUND.","INVENTORY ITEM UNAVAILABLE.","INVENTORY LEVEL NOT FOUND.","INVENTORY LOCATION ALLOCATION INACTIVE.","INVENTORY LOCATION NOT CONFIGURED.","INVENTORY MOVEMENT NOT FOUND.","INVENTORY POLICY INVALID.","INVENTORY POLICY NOT FOUND.","INVENTORY QUANTITY CONFLICT.","INVENTORY RECEIPT CONFLICT.","INVENTORY RECEIPT INVALID.","INVENTORY RECEIPT NOT FOUND.","INVENTORY RESERVATION EXISTS.","INVENTORY RESERVATION EXPIRED.","INVENTORY RESERVATION NOT FOUND.","INVENTORY RESERVATION OWNER MISMATCH.","INVENTORY ROUTING SOURCE INVALID.","INVENTORY ROUTING SOURCE REQUIRED.","INVENTORY ROUTING TOO COMPLEX.","INVENTORY ROUTING UNAVAILABLE.","INVENTORY SHORTAGE.","INVENTORY SOURCE SEQUENCE CHANGED.","INVENTORY TRANSFER ACTION NOT ALLOWED.","INVENTORY TRANSFER CHANGED.","INVENTORY TRANSFER INVALID.","INVENTORY TRANSFER NOT FOUND.","INVENTORY UNAVAILABLE.","INVOICE ACCESS AUTH UNAVAILABLE.","INVOICE AUTOPAY PAYMENT METHOD REQUIRED.","INVOICE AUTOPAY PAYMENT METHOD UNSUPPORTED.","INVOICE BALANCE CHANGED.","INVOICE CHECKOUT REPLACEMENT NOT ALLOWED.","INVOICE COLLECTION BLOCKED.","INVOICE COLLECTION CHANGED.","INVOICE COLLECTION MODE UNSUPPORTED.","INVOICE DRAFT CHANGED.","INVOICE HAS ISSUED CREDIT NOTE.","INVOICE ISSUE IN PROGRESS.","INVOICE LATE FEE NOT COLLECTIBLE.","INVOICE LATE FEE NOT DUE.","INVOICE LATE FEE NOT FOUND.","INVOICE LATE FEE POLICY REQUIRED.","INVOICE LINK UNAVAILABLE.","INVOICE LOCKED ORDER FINANCIALS.","INVOICE NOT COLLECTIBLE.","INVOICE NOT CREDITABLE.","INVOICE NOT DRAFT.","INVOICE NOT FOUND.","INVOICE NOT ISSUED.","INVOICE NOT MARKABLE UNCOLLECTIBLE.","INVOICE NOT REVERSIBLE.","INVOICE NOT VOIDABLE.","INVOICE PAYMENT ALREADY SETTLED.","INVOICE PAYMENT ATTEMPT ACTIVE.","INVOICE PAYMENT FAILED.","INVOICE PAYMENT METHOD FROZEN.","INVOICE PAYMENT OPTIONS REQUIRED.","INVOICE PAYMENT PROCESSING.","INVOICE PAYMENT RESOLVING.","INVOICE PAYMENT TERM CHANGED.","INVOICE PAYMENT TERM IN USE.","INVOICE PAYMENT TERM UNAVAILABLE.","INVOICE PDF UNAVAILABLE.","INVOICE REMINDER RATE LIMITED.","INVOICE SCHEDULE INVALID.","INVOICE SOURCE CONFLICT.","INVOICE SOURCE REQUIRED.","INVOICE TAX SNAPSHOT MISSING.","INVOICE TAX SNAPSHOT STALE.","ITEMS REQUIRED.","LAST NAME REQUIRED.","LATEST REVISION.","LAUNCH TOKEN SCOPE MISMATCH.","LINE ITEM INVALID QUANTITY.","LINE ITEM NAME REQUIRED.","LINE ITEM NAME TOO LONG.","LINE ITEM NEGATIVE PRICE.","LINE ITEM PRICE REQUIRED.","LINE ITEM QUANTITY TOO LARGE.","LINE ITEM REFUND TARGET AMBIGUOUS.","LINE ITEM SOURCE CONFLICT.","LINE ITEM UNIT PRICE REQUIRED.","LIST IN USE.","LIST RESERVED.","LOCATION CHANGED.","LOCATION CONFLICT.","LOCATION GEOGRAPHY CHANGED.","LOCATION GEOGRAPHY INVALID.","LOCATION INVALID.","LOCATION INVENTORY CHANGED.","LOCATION IN USE.","LOCATION NOT ACTIVE.","LOCATION NOT FOUND.","MERCHANTS UNAVAILABLE.","MERCHANT ACCESS REQUIRED.","MERCHANT ACCOUNT NOT READY.","MERCHANT ACCOUNT SESSION ACCOUNT SETUP REPAIR REQUIRED.","MERCHANT ACCOUNT SESSION ACCOUNT SETUP REQUIRED.","MERCHANT ACCOUNT SESSION ACCOUNT SETUP UNAVAILABLE.","MERCHANT ACCOUNT SESSION CONTROLLER MISMATCH.","MERCHANT ACCOUNT SESSION INELIGIBLE.","MERCHANT ACCOUNT SESSION INVALID COMPONENT.","MERCHANT ACCOUNT SESSION INVALID LAUNCH TOKEN.","MERCHANT ACCOUNT SESSION INVALID POLICY COMBINATION.","MERCHANT ACCOUNT SESSION LAUNCH TOKEN SCOPE MISMATCH.","MERCHANT ACCOUNT SESSION POLICY NOT SUPPORTED BY COMPONENT.","MERCHANT ACCOUNT SESSION PREPARATION FAILED.","MERCHANT ACCOUNT SESSION PROVIDER GRANT MISMATCH.","MERCHANT ACCOUNT SESSION TARGETED REMEDIATION UNAVAILABLE.","MERCHANT ACCOUNT SESSION UNAVAILABLE.","MERCHANT ACCOUNT SESSION UNMAPPABLE REQUIREMENT ID.","MERCHANT CHANGED.","MERCHANT CONTEXT MISSING.","MERCHANT FINANCE READ FAILED.","MERCHANT NOT LOADED.","MERCHANT ONBOARDING REQUIRED.","MERCHANT READINESS UNAVAILABLE.","MERCHANT SELECTION REQUIRED.","METADATA KEY TOO LONG.","METADATA TOO LARGE.","METADATA TOO MANY KEYS.","METADATA VALUE TOO LONG.","METHOD NOT ALLOWED.","ME CUSTOMER ID FORBIDDEN.","MINIMUM BALANCE CURRENCY MISMATCH.","MINIMUM BALANCE REQUIRED.","MISSING LINE ITEMS.","MISSING REQUIRED FIELD.","MIXED VARIANT CURRENCIES.","MODIFIERS REQUIRED.","MODIFIERS UNAVAILABLE.","MODIFIER CURRENCY MISMATCH.","MODIFIER DUPLICATE SELECTION.","MODIFIER GROUP CHANGED.","MODIFIER GROUP REQUIRED.","MODIFIER METADATA UNSUPPORTED.","MODIFIER OVERRIDE INVALID.","MODIFIER QUANTITY INVALID.","MODIFIER SELECTION LIMIT EXCEEDED.","MODIFIER SOURCE UNSUPPORTED.","MODIFIER TEXT INVALID.","MODIFIER UNAVAILABLE.","MONEY MOVEMENT HISTORY STATUS INVALID.","MONEY MOVEMENT OPERATION BLOCKED.","MONEY MOVEMENT PROVIDER NOT CONFIGURED.","MONEY MOVEMENT PROVIDER OPERATION FAILED.","MONTHLY PAYOUT DAYS NOT ALLOWED.","MONTHLY PAYOUT DAYS REQUIRED.","MULTIPLE IDENTITIES FOUND.","NAME REQUIRED.","NORMALIZED IMAGE TOO LARGE.","NOTE TOO LONG.","NOTHING TO REFUND FOR TAX BREAKDOWN.","NO DISCOUNTABLE BALANCE.","NO FIELDS TO UPDATE.","NULL NOT ALLOWED.","OAUTH UNAVAILABLE.","ONBOARDING CONTROLLER VERSION UNSUPPORTED.","ONBOARDING DIRECT OWNER REQUIRED.","ONBOARDING PARTNER AUTH UNSUPPORTED.","ONBOARDING PROFILE PROVIDER MANAGED.","ONBOARDING SESSION REQUIRED.","ONBOARDING SESSION TOKEN FAILED.","ONBOARDING UNAVAILABLE.","OPTIONS REQUIRED.","OPTION REQUIRED.","OPTION VALUES REQUIRED.","OPTION VALUE REFERENCE REQUIRED.","OPTION VALUE REQUIRED.","OPTION VALUE TOO LONG.","ORDERS UNAVAILABLE.","ORDER ALREADY CLOSED.","ORDER ALREADY HAS ACTIVE INVOICE.","ORDER CHANGED REFRESH REQUIRED.","ORDER CHARGE ID REQUIRED.","ORDER CHARGE NOT FOUND.","ORDER CHARGE TAX INPUT REQUIRED.","ORDER CLOSED.","ORDER COLLECTION ALREADY ACTIVE.","ORDER COLLECTION IN PROGRESS.","ORDER CONFLICT.","ORDER CUSTOMER ALREADY SET.","ORDER CUSTOMER CHECKOUT ACTIVE.","ORDER CUSTOMER NOT CLEARABLE.","ORDER CUSTOMER NOT UPDATABLE AFTER PAYMENT.","ORDER DELAYED CAPTURE SPLIT PAYMENT UNSUPPORTED.","ORDER DISCOUNT NO CHARGE IDS.","ORDER DISCOUNT NO LINE ITEM IDS.","ORDER FINANCIAL MUTATION NOT ALLOWED.","ORDER LINE ITEM ID REQUIRED.","ORDER LINE ITEM TAX INPUT REQUIRED.","ORDER LINE ITEM VERSION CONFLICT.","ORDER NOT FOUND.","ORDER OWNED PAYMENT INTENT REQUIRED.","ORDER PAYMENT ATTEMPT ACTIVE.","ORDER PAYMENT FLOW REQUIRED.","ORDER PAYMENT INTENT CREATE IN PROGRESS.","ORDER PAYMENT LEG ALREADY SETTLED.","ORDER PERCENTAGE TAX FORBIDDEN.","ORDER RECEIPT EMAIL UNAVAILABLE.","ORDER RECEIPT MERCHANT MANAGED.","ORDER RECEIPT NOT AVAILABLE.","ORDER RECEIPT RESEND RATE LIMITED.","ORDER RECONCILIATION REQUIRED.","ORDER REFUNDED.","ORDER REQUIRED FOR TAX BREAKDOWN REFUND.","ORDER STATUS NOT CLOSABLE.","ORDER TAX CALCULATION FAILED.","ORDER TAX LOCATION INVALID.","ORDER TAX LOCATION REQUIRED.","ORDER TAX NOT READY.","ORDER TAX NOT UPDATABLE AFTER PAYMENT.","ORDER TAX RATE UNAVAILABLE.","ORDER TAX UNSUPPORTED COUNTRY.","ORDER TIP MODEL UNSUPPORTED.","ORDER TOTAL BELOW NET COLLECTED.","ORDER UNAVAILABLE.","ORG SCOPE RESOLUTION FAILED.","PACKAGE ACTION NOT ALLOWED.","PACKAGE CHANGED.","PACKAGE PARENT CHANGED.","PACKAGE REQUIRED.","PARTNER APP INSTALL NOT FOUND.","PARTNER APP MANAGEMENT REQUIRES LIVE KEY.","PARTNER APP NOT FOUND.","PARTNER AUTH UNSUPPORTED.","PARTNER TOKEN VALIDATION FAILED.","PAYMENT ACTION EXPIRED.","PAYMENT ACTION WINDOW TOO SHORT.","PAYMENT ATTEMPT FROZEN.","PAYMENT ATTEMPT ID REQUIRED.","PAYMENT ATTEMPT IN PROGRESS.","PAYMENT ATTEMPT MISMATCH.","PAYMENT ATTEMPT NOT RESUMABLE.","PAYMENT ATTEMPT RESUME CONFLICT.","PAYMENT ATTEMPT STILL PROCESSING.","PAYMENT BLOCKED.","PAYMENT CAPTURE METHOD NOT ALLOWED.","PAYMENT CONFIRMATION STATE CHANGED.","PAYMENT FAILED.","PAYMENT INTENT AMOUNT INVALID.","PAYMENT INTENT CAPTURE METHOD UNSUPPORTED.","PAYMENT INTENT CHECKOUT ALREADY EXISTS.","PAYMENT INTENT CHECKOUT CHANGED.","PAYMENT INTENT CHECKOUT COMMERCE CONFIG UNSUPPORTED.","PAYMENT INTENT CHECKOUT SOURCE CONFLICT.","PAYMENT INTENT HAS ORDER.","PAYMENT INTENT NOT COLLECTIBLE.","PAYMENT INTENT NOT FOUND.","PAYMENT INTENT OPTIONS IMMUTABLE.","PAYMENT INTENT OPTIONS REQUIRED.","PAYMENT INTENT OPTIONS UNSUPPORTED.","PAYMENT LEG SELECTION REQUIRED.","PAYMENT LINKS UNAVAILABLE.","PAYMENT LINK CHANGED.","PAYMENT LINK CHANGED RETRY.","PAYMENT LINK FULFILLMENT UNAVAILABLE.","PAYMENT LINK NOT FOUND.","PAYMENT LINK RESOLUTION CONTEXT INVALID.","PAYMENT LINK RESOLUTION CONTEXT REFRESH REQUIRED.","PAYMENT LINK RESOLUTION CONTEXT REQUIRED.","PAYMENT LINK RESOLUTION RATE LIMITED.","PAYMENT LINK RESOLUTION REPLAY UNAVAILABLE.","PAYMENT LINK RESOLUTION UNAVAILABLE.","PAYMENT METHOD CUSTOMER MISMATCH.","PAYMENT METHOD DECLINED.","PAYMENT METHOD DOMAINS UNAVAILABLE.","PAYMENT METHOD DOMAIN ALREADY EXISTS.","PAYMENT METHOD DOMAIN NOT FOUND.","PAYMENT METHOD DOMAIN OPERATION IN PROGRESS.","PAYMENT METHOD DOMAIN REGISTRATION FAILED.","PAYMENT METHOD NOT ACTIVE.","PAYMENT METHOD NOT READY.","PAYMENT METHOD REQUIRED.","PAYMENT METHOD TEMPORARILY UNAVAILABLE.","PAYMENT METHOD UNAVAILABLE.","PAYMENT NOT COMPLETED.","PAYMENT NOT REQUIRED.","PAYMENT OPERATION IN PROGRESS.","PAYMENT OPTIONS REQUIRED.","PAYMENT OPTION LIMIT EXCEEDED.","PAYMENT OPTION NOT ALLOWED.","PAYMENT OPTION NOT READY.","PAYMENT OPTION RESOLVE FAILED.","PAYMENT PROCESSING UNAVAILABLE.","PAYMENT RETURN URL INVALID.","PAYMENT RETURN URL REQUIRED.","PAYMENT SOURCE CONFLICT.","PAYMENT SOURCE NOT ALLOWED.","PAYMENT SOURCE OWNERSHIP MISMATCH.","PAYMENT SOURCE REQUIRED.","PAYMENT SOURCE SELECTION CONFLICT.","PAYMENT SOURCE SELECTION REQUIRED.","PAYMENT SOURCE UNAVAILABLE.","PAYMENT START SHAPE CONFLICT.","PAYOUT DELAY PROVIDER CONTROLLED.","PAYOUT DESTINATION NOT FOUND.","PAYOUT DESTINATION UPDATE EMPTY.","PAYOUT ENTRIES UNAVAILABLE.","PAYOUT FEE NOT DETERMINABLE.","PAYOUT NOT CANCELABLE.","PAYOUT NOT FOUND.","PAYOUT SETTINGS MANAGED EXTERNALLY.","PAYOUT SETTINGS SNAPSHOT UNAVAILABLE.","PAYOUT SETTINGS UPDATE EMPTY.","PAYOUT STATUS NOT CANCELABLE.","PLAN NOT ACTIVE.","POLICY NOT SUPPORTED BY COMPONENT.","PROCESSING ERROR.","PROCESSING FEE PRICING NOT AUTHORIZED.","PROCESSING FEE PRICING UNAVAILABLE.","PRODUCT LINE ITEM SOURCE UNSUPPORTED.","PROFILE RECONCILIATION PENDING.","PROFILE UPDATE STATUS UNKNOWN.","PROFILE WRITE LIVE MODE REQUIRED.","PROMOTION CONFLICT.","PROMOTION DECLINED.","PROMOTION FILTER TARGET CONFLICT.","PROMOTION ID REQUIRED.","PROMOTION NOT REDEEMABLE.","PROMOTION NO ACTIVE CODES.","PROVIDER ACCOUNT CLEANUP REQUIRED.","PROVIDER READINESS UNAVAILABLE.","PROVISIONING FAILED.","RANGE REQUIRED.","RATE LIMIT EXCEEDED.","READ ONLY REASON.","RECIPIENT EMAIL REQUIRED.","REFUND ADJUSTMENT AMOUNT MONEY REQUIRED.","REFUND ADJUSTMENT REASON REQUIRED.","REFUND ADJUSTMENT REFUND AMOUNT MONEY REQUIRED.","REFUND INSUFFICIENT AVAILABLE BALANCE.","REFUND LINE ITEM ADJUSTMENT ID REQUIRED.","REFUND SUBMISSION DEADLINE EXPIRED.","RELATED OBJECT ID UNSUPPORTED FOR TYPE.","RELATED OBJECT TYPE REQUIRED.","REPORTING UNAVAILABLE.","REPORT DOWNLOAD EXPIRED.","REPORT INTERVAL INCOMPLETE.","REPORT INTERVAL TOO LARGE.","REPORT NOT FOUND.","REQUEST BODY NOT ALLOWED.","REQUEST FAILED.","REQUEST TIMEOUT.","RESERVED FIELD NOT YET SUPPORTED.","RESERVED METADATA KEY.","RESOURCE LIMIT EXCEEDED.","RESOURCE NOT FOUND.","RESOURCE TIMELINE TOKEN INVALID.","RETURN ACTION NOT ALLOWED.","RETURN COMPLETION BLOCKED.","RETURN DECISION SCOPE REQUIRED.","RETURN DISPOSITION QUANTITY EXCEEDED.","RETURN FULFILLMENT ALLOCATION AMBIGUOUS.","RETURN INSPECTION QUANTITY EXCEEDED.","RETURN INVALID.","RETURN LINE CANCELLATION CONFLICT.","RETURN NOT FOUND.","RETURN PAYMENT INTENT MISMATCH.","RETURN POLICY CONFLICT.","RETURN RECEIPT QUANTITY EXCEEDED.","RETURN VALUE EXCEEDED.","RETURN VERSION CONFLICT.","REVIEW ALREADY CLOSED.","REVIEW NOT FOUND.","REVIEW RESOLUTION IN PROGRESS.","RISK CONTROL CONFLICT.","RISK EVALUATION UNAVAILABLE.","RISK LIST ALIAS ALREADY EXISTS.","RISK RESOURCE NOT FOUND.","ROUTE NOT FOUND.","RULE LIMIT EXCEEDED.","RULE RESERVED.","SANDBOXES UNAVAILABLE.","SANDBOX ALREADY EXISTS.","SANDBOX ARCHIVED.","SANDBOX ARCHIVE FAILED.","SANDBOX BOOTSTRAP FAILED.","SANDBOX CREATE FAILED.","SANDBOX ID NOT ALLOWED.","SANDBOX ID REQUIRED.","SANDBOX INACTIVE.","SANDBOX LIST FAILED.","SANDBOX LOOKUP FAILED.","SANDBOX MANAGEMENT REQUIRES LIVE KEY.","SANDBOX NOT ACCESSIBLE.","SANDBOX NOT FOUND.","SANDBOX PLANE UNAVAILABLE.","SANDBOX RESET FAILED.","SANDBOX RESET UNAVAILABLE.","SANDBOX SELECTION FORBIDDEN.","SANDBOX SELECTION REQUIRED.","SCOPES REQUIRED.","SCOPE NOT ALLOWED.","SCOPE NOT ALLOWED FOR KEY MODE.","SENSITIVE IDEMPOTENCY ENCRYPTION INVALID.","SENSITIVE IDEMPOTENCY ENCRYPTION UNCONFIGURED.","SENSITIVE IDEMPOTENCY RESULT INVALID.","SERVER GENERATED ID.","SERVICE CHARGE DISCOUNT NO LINE ITEM IDS.","SERVICE CHARGE DISCOUNT REQUIRES CHARGE IDS.","SERVICE CHARGE DISCOUNT SCOPE INVALID.","SERVICE UNAVAILABLE.","SETTINGS CONCURRENT MODIFICATION.","SETTINGS UNAVAILABLE.","SHIPMENT CHANGED.","SOURCE CONTEXT CONFLICT.","STANDARD PAYOUT REQUIRES MANUAL SCHEDULE.","STREAMING UNAVAILABLE.","SUBSCRIPTION BILLING SCHEDULE REQUIRED.","SUBSCRIPTION BILLING START INVALID.","SUBSCRIPTION CANCELED.","SUBSCRIPTION EXTERNAL BILLING ANCHOR NOT ALLOWED.","SUBSCRIPTION IMPORT PERIOD NOT CURRENT.","SUBSCRIPTION INITIATED BY INVALID.","SUBSCRIPTION NEXT BILLING AT BEFORE PERIOD START.","SUBSCRIPTION NEXT BILLING AT NOT FUTURE.","SUBSCRIPTION NEXT BILLING AT REQUIRED.","SUBSCRIPTION NEXT BILLING AT TOO FAR.","SUBSCRIPTION NOT FOUND.","SUBSCRIPTION PAYMENT RETRY NOT ALLOWED.","SUBSCRIPTION PLAN NOT FOUND.","SUBSCRIPTION SCHEDULE CLEAR NOT ALLOWED.","SUBSCRIPTION SCHEDULE MUTATION NOT ALLOWED.","SUBSCRIPTION SERVICE LOCATION INVALID.","SUBSCRIPTION STARTS AT NOT FUTURE.","SUBSCRIPTION STARTS AT TRIAL CONFLICT.","SUBSCRIPTION START OVERRIDE NOT ALLOWED.","TARGETED REMEDIATION UNAVAILABLE.","TAX BREAKDOWN ID REQUIRED.","TAX BREAKDOWN NOT ORDER SCOPED FLAT.","TAX BREAKDOWN REFUND MONEY REQUIRED.","TAX BREAKDOWN TARGETS EXCEED REFUND AMOUNT.","TAX CALCULATION REQUIRED.","TAX INPUT CONFLICT.","TAX MODE MISMATCH.","TIP ALLOCATION CAPACITY EXCEEDED.","TIP CURRENCY MISMATCH.","TIP LIMIT EXCEEDED.","TOO MANY LINE ITEMS.","TOO MANY PENDING REPORTS.","TRANSACTION PURPOSE NOT APPLICABLE.","TRANSACTION PURPOSE REQUIRED.","UNKNOWN BUNDLE COMPONENT.","UNKNOWN CLIENT OPTION VALUE.","UNKNOWN FIELD.","UNKNOWN OPTION.","UNKNOWN OPTION VALUE.","UNKNOWN SCOPE.","UNMAPPABLE REQUIREMENT ID.","UNSAFE FEEDBACK CONTENT.","UNSUPPORTED APPLICATION TYPE.","UNSUPPORTED CONTENT TYPE.","UNSUPPORTED CURRENCY.","UNSUPPORTED PRODUCT FIELD.","UNSUPPORTED QUERY PARAM.","UNSUPPORTED RESOURCE TYPE.","UPDATE MASK REQUIRED.","USE CANCEL SUBSCRIPTION.","VALIDATION ERROR.","VALUE REQUIRED.","VARIANTS REQUIRED.","VARIANT IN ACTIVE BUNDLE.","VARIANT NOT SELLABLE.","VARIANT OPTION COMBINATION ALREADY EXISTS.","VERIFICATION ALREADY USED.","VERIFICATION CODE FAILED.","VERIFICATION EMAIL FAILED.","VERIFICATION TOKEN FAILED.","WEBHOOKS UNAVAILABLE.","WEBHOOK DELIVERY IN FLIGHT.","WEBHOOK DELIVERY UNAVAILABLE.","WEBHOOK ENDPOINT NOT ACTIVE.","WEBHOOK EVENT PAYLOAD EXPIRED.","WEBHOOK STREAM CONNECTION LIMIT.","WEBHOOK STREAM LIMITER UNAVAILABLE.","WEBHOOK STREAM NOTIFIER UNAVAILABLE.","WEEKLY PAYOUT DAYS NOT ALLOWED.","WEEKLY PAYOUT DAYS REQUIRED."],"x-flint-enum":"closed","x-flint-enum-descriptions":{"ACCOUNT_SETUP_CONFIGURATION_CONFLICT":"The stored account-provisioning configuration is not supported by this application release. Contact Flint support to repair the account setup configuration before retrying.","ACCOUNT_SETUP_REPAIR_REQUIRED":"The merchant is not ready for this operation. Complete the required merchant readiness or onboarding action before retrying.","ACCOUNT_SETUP_REQUIRED":"The merchant is not ready for this operation. Complete the required merchant readiness or onboarding action before retrying.","ACCOUNT_SETUP_UNAVAILABLE":"The merchant is not ready for this operation. Complete the required merchant readiness or onboarding action before retrying.","ACTIVE_BUNDLE_COMPONENTS_IMMUTABLE":"An active bundle cannot replace its components. Set the bundle to inactive, then replace components using the latest version.","ACTIVE_DEMO_SESSION_EXISTS":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","ACTIVE_OPTIONS_REQUIRED":"An optioned product must contain at least one active option. Include at least one active option and its active values.","ACTIVE_OPTION_SELECTOR_COLLAPSE":"The option replacement would make active variant selections indistinguishable. Keep enough active options and values to distinguish every active variant.","ACTIVE_VARIANTS_REQUIRE_OPTION_BACKFILL":"An active option cannot be added while active variants lack a selection for it. Inactivate the variants or backfill their option selections before adding the active option.","AFFIRM_REFUND_RETRY_NOT_ALLOWED":"A failed provider refund already exists for this Affirm payment. Do not create a new provider refund. Use an alternative reimbursement and reconcile the failed Refund.","AMBIGUOUS_AUTH":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","AMOUNT_MONEY_CURRENCY_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","AMOUNT_MONEY_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","API_KEYS_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","API_KEY_DATA_INVALID":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","API_KEY_EXPIRED":"The API key exists but is past its expiration time. Create or use an active API key for the target mode and merchant, then retry.","API_KEY_MODE_MISMATCH":"The API key is not usable for its stored payment-mode binding. Create or use an API key whose mode matches the target environment, then retry.","API_KEY_NOT_FOUND":"No API key matches the provided credential. Check the API key value or create a new API key, then retry.","API_KEY_REQUIRED":"The request did not include an API key or accepted bearer credential. Send a Flint API key in X-API-Key or as Authorization: Bearer \u003cAPI_KEY\u003e, then retry.","API_KEY_REVOKED":"The API key exists but has been revoked. Create or use an active API key for the target mode and merchant, then retry.","API_KEY_SANDBOX_UNAVAILABLE":"The API key is bound to a sandbox that is missing, archived, inactive, or mode-incompatible. Create or use a sandbox-bound test key for an active sandbox, then retry.","API_KEY_SCOPE_INVALID":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","API_KEY_SCOPE_UNSUPPORTED":"The API key uses a legacy or unsupported scope grant. Create a new API key with explicit public API scopes, then retry.","API_VERSION_CHANGED":"The API version changed before the update was committed. Reload the resource, review its current API version, and retry with that value as expected_api_version.","API_VERSION_RETIRED":"The requested API version has retired. Set Flint-Version to a supported version listed in the error details.","APPLICATION_METHOD_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","ARCHIVED_CATEGORY":"The category is archived and cannot be assigned. Use an active category or create one with a different handle.","AUTHENTICATION_FAILED":"The request could not be authenticated. Send a valid Flint API key, partner install token, checkout session credential, or dashboard session for this route, then retry.","AUTHENTICATION_REQUIRED":"The payment attempt was declined or could not be completed. Use the remediation next_actions and retry only after changing the requested payment inputs.","AUTHORIZATION_FAILED":"The authenticated caller is not authorized for this operation. Use credentials with access to the target merchant, environment, route, and scope, then retry.","AUTH_CONTEXT_MISSING":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","AUTH_REQUIRED":"The request could not be authenticated. Send a valid Flint credential supported by this endpoint, then retry.","AUTH_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","AUTH_VALIDATION_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","AUTOMATIC_PAYOUT_NOT_CANCELABLE":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","AUTOMATIC_TAX_COMPONENTS_FORBIDDEN":"The tax calculation includes components in automatic mode. Omit components, or use external mode with caller-supplied components.","AUTOMATIC_TAX_EXEMPTION_UNSUPPORTED":"Automatic tax cannot apply a customer tax exemption. Use external tax for an exempt customer, or remove the customer exemption before retrying automatic tax.","AUTOMATIC_TAX_INVOICE_INSTALLMENTS_UNSUPPORTED":"An automatic tax invoice cannot be split into installments. Send a single full-balance schedule entry, omit schedule_entries, or use external tax.","AUTOMATIC_TAX_MULTIPLE_DESTINATIONS":"Automatic tax found more than one buyer destination for taxable components. Use one buyer destination for all taxable components, or use external tax.","AUTOMATIC_TAX_MULTIPLE_ORIGINS":"Automatic tax found more than one seller origin. Split the items into separate orders with one seller origin each, or use external tax.","AUTOMATIC_TAX_PARTIAL_PAYMENT_UNSUPPORTED":"An automatic tax invoice takes one payment for the full balance. Record or collect the full outstanding balance in one payment, or use external tax.","AUTOMATIC_TAX_POST_TAX_DISCOUNT_UNSUPPORTED":"Automatic tax cannot calculate a post-tax subtotal discount. Use subtotal_pre_tax for the discount calculation basis, or use external tax.","AVAILABLE_MERCHANT":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","BALANCE_SNAPSHOT_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","BALANCE_SOURCE_TYPE_REQUIRED":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","BALANCE_TRANSACTION_NOT_FOUND":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","BANK_ACCOUNT_CLOSED":"The payment attempt was declined or could not be completed. Use the remediation next_actions and retry only after changing the requested payment inputs.","BANK_ACCOUNT_NOT_FOUND":"The payment attempt was declined or could not be completed. Use the remediation next_actions and retry only after changing the requested payment inputs.","BANK_ACCOUNT_RESTRICTED":"The payment attempt was declined or could not be completed. Use the remediation next_actions and retry only after changing the requested payment inputs.","BANK_DEBIT_LIMIT_EXCEEDED":"The payment attempt was declined or could not be completed. Use the remediation next_actions and retry only after changing the requested payment inputs.","BANK_DEBIT_NOT_AUTHORIZED":"The payment attempt was declined or could not be completed. Use the remediation next_actions and retry only after changing the requested payment inputs.","BUNDLE_COMPONENTS_REQUIRED":"An active bundle requires at least one component. Include at least one valid component or create the bundle as inactive.","BUNDLE_COMPONENT_PRODUCT_NOT_ACTIVE":"A bundle component references a product that is not active. Use a variant whose parent product is active, or keep the bundle inactive.","BUNDLE_COMPONENT_VARIANT_NOT_ACTIVE":"A bundle component references a variant that is not active. Use an active variant, or keep the bundle inactive.","BUNDLE_NOT_SELLABLE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","BUYER_FULFILLMENT_CORRELATION_FORBIDDEN":"Buyer credentials cannot set merchant-owned fulfillment correlation fields. Remove external_system and external_reference. Set merchant correlation from a server-authenticated request.","BUYER_INVOICE_CREDENTIAL_INVALID":"The customer session or invoice access token is invalid or expired. Authenticate the buyer again or use the current token from this invoice's public URL.","BUYER_INVOICE_CREDENTIAL_REQUIRED":"The endpoint requires a customer session or invoice access token. Send either credential in the Authorization bearer header.","CANNOT_PAUSE":"The subscription cannot be paused in its current status. Fetch the subscription and pause it only from an active state.","CANNOT_RESUME":"The subscription cannot be resumed in its current status. Fetch the subscription and resume it only from a paused state.","CANNOT_RESUME_INITIAL_PAYMENT_PENDING":"The subscription is still waiting for its initial payment. Complete or recover the initial payment instead of resuming the subscription.","CANNOT_RESUME_PAST_DUE_PAYMENT_REQUIRED":"The past-due subscription must recover through payment. Update the payment method and create or await a payment retry.","CAPABILITIES_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","CAPABILITY_SET_UNSUPPORTED":"The requested onboarding capability combination is not supported by Flint's current merchant-account configuration. Request accept_card_payments and receive_payouts together. You may also include accept_ach_debit_payments, or omit requested_capabilities to use the default set.","CAPABILITY_SNAPSHOT_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","CAPTURE_AMOUNT_EXCEEDS_CAPTURABLE":"The requested capture exceeds the authorization's current capturable amount. Use an amount no greater than capturable_money, or omit amount_money to capture the available authorization.","CAPTURE_CURRENCY_MISMATCH":"The requested capture currency differs from the authorization currency. Send amount_money in the capturable authorization currency.","CARD_DECLINED":"The payment attempt was declined or could not be completed. Use the remediation next_actions and retry only after changing the requested payment inputs.","CATALOG_INVENTORY_RELATIONSHIP_INVALID":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","CATALOG_LINE_ITEM_CURRENCY_CHANGED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","CATALOG_LINE_ITEM_FIELDS_READ_ONLY":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","CATALOG_LINE_ITEM_SOURCE_CHANGED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","CATALOG_MODIFIERS_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","CATEGORY_HANDLE_EXISTS":"Another category already uses this handle. Use the existing category or choose a different handle.","CATEGORY_MODIFIED":"The category changed while this update was being committed. Fetch the category and retry the intended update.","CATEGORY_REFERENCED":"The category is still referenced and cannot be deleted. Remove the category from every product, bundle, promotion, and return setting, then retry.","CATEGORY_TARGETED":"The category is still targeted and cannot be archived. Remove the category from every promotion and return setting, then retry.","CHALLENGE_FAILED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","CHALLENGE_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","CHALLENGE_TOKEN_INVALID":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","CHARGE_NAME_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","CHARGE_TYPE_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","CHECKOUT_CREDENTIAL_CHANGED":"Checkout authentication was rotated before payment work became durable. Refresh the checkout session through its owning invoice or checkout entry point, then resume the same payment attempt if it remains available.","CHECKOUT_DISCOUNT_ID_NOT_ALLOWED":"Checkout buyers cannot apply discounts by resource ID. Provide the buyer-facing promotion code instead.","CHECKOUT_DISCOUNT_NOT_REMOVABLE":"Checkout buyers can remove only promotion-code discounts. Remove a buyer-applied code discount or ask the merchant to change other discounts.","CHECKOUT_LAUNCH_TOKEN_RESTRICTED":"The checkout launch credential is scoped to hosted checkout bootstrap and cannot authorize public API operations. Open the hosted checkout URL so Flint can exchange the launch credential for a checkout session credential.","CHECKOUT_MANUAL_DISCOUNT_NOT_ALLOWED":"Checkout buyers cannot create manual discounts. Apply a promotion through checkout, or create the manual discount with merchant authentication.","CHECKOUT_ORDER_UPDATE_FIELD_NOT_ALLOWED":"The checkout credential cannot update this order field. Send only requested_tip or tax, or use a merchant credential for other order fields.","CHECKOUT_PAYMENT_RESOLVING":"Checkout payment work is still resolving, so the competing change cannot proceed yet. Wait briefly, then retry the same request after the payment attempt converges.","CHECKOUT_RECOVERY_ATTEMPT_MISMATCH":"The expired checkout session is in constrained recovery mode and the request targets a different payment attempt. Read or resume only the payment attempt identified by the checkout session recovery response.","CHECKOUT_RECOVERY_RESTRICTED":"The expired checkout session is in constrained recovery mode and cannot perform this operation. Read the order or owning payment attempt, or resume that exact payment attempt before the recovery deadline.","CHECKOUT_REPLACEMENT_REQUIRES_ORDER":"replace_checkout_session_id is only valid when creating an order-backed checkout session. Send replace_checkout_session_id together with order_id, without quick_pay_item or plan_id.","CHECKOUT_SESSIONS_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","CHECKOUT_SESSION_ALREADY_EXISTS":"An open checkout session already exists for this order. Reuse the session identified by existing_checkout_session_id, or send that ID as replace_checkout_session_id to replace it atomically.","CHECKOUT_SESSION_AUTH_REQUIRED":"The request could not be authenticated. Send a valid Flint credential supported by this endpoint, then retry.","CHECKOUT_SESSION_AUTH_UNAVAILABLE":"The request could not be authenticated. Send a valid Flint credential supported by this endpoint, then retry.","CHECKOUT_SESSION_CURRENT_CHANGED":"The session named by replace_checkout_session_id is no longer the order's current open session. Read the session identified by current_checkout_session_id, then retry replacement against that ID if a new session is still needed.","CHECKOUT_SESSION_LOOKUP_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","CHECKOUT_SESSION_MODIFIERS_READ_ONLY":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","CHECKOUT_SESSION_MODIFIER_FIELDS_ONLY":"Checkout sessions can only update line item modifiers. Send only modifiers and expected_version, or use an API key.","CHECKOUT_SESSION_MODIFIER_UPDATE_LINE_ITEM_MISSING":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","CHECKOUT_SESSION_MODIFIER_UPDATE_MISSING_ORDER":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","CHECKOUT_SESSION_NOT_FOUND":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","CHECKOUT_SESSION_NOT_OPEN":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","CHECKOUT_SESSION_ORDER_MISMATCH":"The authenticated caller is not authorized for this operation. Use credentials with access to the target merchant, environment, route, and scope, then retry.","CHECKOUT_SESSION_PAYMENT_REQUIRED":"The resource is available to checkout authentication only after the checkout session is paid. Complete payment, then retry with the same checkout session credential.","CHECKOUT_SESSION_REQUIRED":"The request could not be authenticated. Send a valid Flint credential supported by this endpoint, then retry.","CHECKOUT_SESSION_REVISION_CONFLICT":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","CHECKOUT_SESSION_REVISION_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","CHECKOUT_SESSION_REVISION_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","CHECKOUT_SESSION_SCOPE_MISMATCH":"The checkout credential is bound to a different checkout session. Use the credential issued for this checkout session.","CHECKOUT_SESSION_SECRET_REQUIRED":"The request could not be authenticated. Send a valid Flint credential supported by this endpoint, then retry.","CHECKOUT_TAX_CALCULATION_LIMIT_REACHED":"The checkout session reached its tax calculation limit. Start a new checkout session or contact the merchant before calculating tax again.","CHECKOUT_TIPPING_DISABLED":"Tipping is disabled for this checkout session. Continue without a tip or start a checkout session with tipping enabled.","CHECKOUT_TIP_NOT_ALLOWED":"The requested tip is not available for this checkout session. Choose one of the checkout session's configured tips or enable custom tipping.","CLERK_EMAIL_MISSING":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","CLERK_EMAIL_VERIFY_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","CLERK_USER_CREATE_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","CLERK_USER_LOOKUP_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","CODE_TOO_LONG":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","COMPONENT_REQUIRED":"A bundle component entry is missing. Replace the empty entry with a valid component or remove it from the array.","CONCURRENT_MODIFICATION":"The resource changed while the operation was being committed. Fetch the current resource and retry the intended operation with its version.","CONFIRMATION_RETURN_URL_INVALID":"The ConfirmationToken contains a malformed payment return URL. Create a new ConfirmationToken using the exact payment_collection.stripe.return_url.","CONFIRMATION_RETURN_URL_NOT_ALLOWED":"The ConfirmationToken return URL does not match this payment's active Flint relay. Create a new ConfirmationToken using the exact payment_collection.stripe.return_url for this payment.","CONFIRMATION_RETURN_URL_REQUIRED":"The ConfirmationToken does not contain Flint's payment return relay URL. Create a new ConfirmationToken using the exact payment_collection.stripe.return_url.","CONTEXT_NOT_FOUND":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","COUNTRY_NOT_SUPPORTED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","CREATE_ORDER_LINE_ITEM_DISCOUNT_UNSUPPORTED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","CREDIT_NOTE_ALLOCATION_ALREADY_REVERSED":"The credit note allocation was already reversed. Read the allocation to confirm its reversed_at value.","CREDIT_NOTE_ALLOCATION_EXCEEDS_BALANCE":"The allocation exceeds an available balance. Use an amount no greater than both the credit note's unallocated amount and the invoice's outstanding amount.","CREDIT_NOTE_AMOUNT_EXCEEDS_CREDITABLE":"The correction exceeds the invoice line's remaining creditable value. Reduce the correction amount or quantity.","CREDIT_NOTE_CHANGED":"The credit note version changed. Retrieve the credit note and retry with its current version as expected_version.","CREDIT_NOTE_CURRENCY_MISMATCH":"The refund currency does not match the credit note. Use the credit note currency.","CREDIT_NOTE_HAS_ALLOCATIONS":"The credit note has active allocations. Reverse every allocation before voiding the credit note.","CREDIT_NOTE_ISSUE_IN_PROGRESS":"Another credit note is being issued for this merchant. Retry with the same Idempotency-Key after the current issue finishes.","CREDIT_NOTE_NOT_DRAFT":"Only draft credit notes can be changed. Create a new draft credit note for another correction.","CREDIT_NOTE_NOT_ISSUED":"The credit note has not been issued. Issue the credit note before allocating it or downloading its PDF.","CREDIT_NOTE_REFUND_EXCEEDS_BALANCE":"The refund exceeds the available credit. Use an amount no greater than the credit note unallocated_money.","CREDIT_NOTE_REFUND_INVALID":"The credit note refund request is invalid. Use a paid invoice, an eligible credit note, and a caller-chosen idempotency key.","CURRENCY_MISMATCH":"The amount uses a different currency from the resource it applies to. Send the amount in the currency of the invoice, order, payment, or plan it belongs to.","CURSOR_MISMATCH":"The webhook stream resume values disagree. Send either Last-Event-ID or after_event_id, or make both values identical.","CUSTOMER_ACCOUNTS_UNAVAILABLE":"Customer account resources are temporarily unavailable. Retry with exponential backoff.","CUSTOMER_ACCOUNT_RESOURCE_NOT_FOUND":"The customer account resource was not found for this customer. Check the resource ID. Customer-session routes never reveal another customer's resources.","CUSTOMER_DELETION_BLOCKED":"The customer still has subscriptions or saved payment methods that could remain operational after account deletion. Cancel every non-canceled subscription and remove every saved payment method, then retry approval.","CUSTOMER_DELETION_PROCESSING":"The customer is being deleted and cannot accept subscription changes. Wait for customer deletion to finish or use a different active customer.","CUSTOMER_EMAIL_ALREADY_USED":"The requested email is already associated with another customer for this merchant. Use a different email address or reconcile the duplicate customer records.","CUSTOMER_SESSIONS_UNAVAILABLE":"Customer sessions are temporarily unavailable. Retry with exponential backoff. Contact support with the request_id if the error persists.","CUSTOMER_SESSION_EXPIRED":"The customer session use window expired. Refresh the customer session with its refresh token, then retry with the new secret.","CUSTOMER_SESSION_NOT_FOUND":"The customer or customer session was not found in the selected merchant environment. Check the resource ID and selected environment.","CUSTOMER_SESSION_REFRESH_EXPIRED":"The customer session refresh token is invalid or expired. Authenticate the buyer again and mint a new customer session.","CUSTOMER_SESSION_REFRESH_REUSED":"A rotated customer session refresh token was presented again, so the session family was revoked. Authenticate the buyer again and mint a new customer session.","CUSTOMER_SESSION_REQUIRED":"The endpoint requires a customer session bearer credential. Send the customer session secret in the Authorization bearer header.","CUSTOM_DOMAIN_NOT_VERIFIED":"The customer account custom hostname has not completed domain validation. Create and validate the hostname as a payment method domain before saving it as the customer account domain.","DAILY_LIMIT_EXCEEDED":"The request exceeded a Flint rate or usage limit. Retry with exponential backoff and jitter. Use the Retry-After header when present.","DANGLING_EXPANSION_REFERENCE":"A public resource referenced another resource that could not be resolved during expansion. Contact support with the request_id; this indicates a Flint data-integrity defect.","DEFAULT_ENVIRONMENT_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","DEFAULT_PAYOUT_DESTINATIONS_MANAGED_EXTERNALLY":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","DEFAULT_PAYOUT_DESTINATION_INVALID":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","DEFAULT_PAYOUT_DESTINATION_REPLACEMENT_REQUIRED":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","DEFAULT_PAYOUT_DESTINATION_REQUIRED":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","DEFAULT_SANDBOX_CANNOT_BE_ARCHIVED":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","DEFAULT_SANDBOX_CANNOT_BE_RESET":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","DEFAULT_VARIANT_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","DELIVERY_CALCULATION_EXPIRED":"The calculation behind the delivery selection expired before payment began. Create a new delivery quote, select a current option, and retry payment.","DELIVERY_CALLER_RATES_UNAVAILABLE_TO_BUYER":"This checkout requires a rate supplied by the merchant server. Create the delivery quote from the merchant server and then let the buyer select from the resulting options.","DELIVERY_COMMERCE_TREATMENT_UNSUPPORTED":"The selected delivery obligations require incompatible commerce treatment. Change the delivery method or obligation configuration so the selected quantities share compatible tax, currency, and destination treatment.","DELIVERY_CONFIGURATION_INVALID":"The delivery configuration does not satisfy its typed contract. Fix the field identified by the response and retry.","DELIVERY_DEPENDENCY_REVOKED":"A pinned delivery dependency was revoked and can no longer authorize a new quote or selection. Publish or select a replacement configuration revision, then create a new quote.","DELIVERY_DESTINATION_ADDRESS_INCOMPLETE":"The delivery address is incomplete. Provide line1, city, and country, then retry.","DELIVERY_DESTINATION_ADDRESS_REQUIRED":"The order requires a complete delivery address. Provide delivery_destination.address and retry.","DELIVERY_DESTINATION_CONTROLLED_BY_SELECTION":"The current delivery selection controls the order's delivery destination. Change or clear the delivery selection instead of updating delivery_destination directly.","DELIVERY_DESTINATION_COUNTRY_INVALID":"The delivery address country is invalid. Use a two-letter ISO 3166-1 country code and retry.","DELIVERY_DESTINATION_FIELD_TOO_LONG":"A delivery destination field exceeds its maximum length. Shorten the field identified by param and retry.","DELIVERY_DESTINATION_FROZEN":"The order's delivery destination can no longer be changed. Read the current order and use fulfillment recipient corrections for execution changes.","DELIVERY_DESTINATION_INVALID":"The delivery destination is invalid. Fix the destination field identified by the response and retry.","DELIVERY_DESTINATION_NOT_APPLICABLE":"This order has no shipment or local delivery that can use a delivery destination. Remove delivery_destination or add a line item with a shipment or local-delivery obligation.","DELIVERY_DESTINATION_UPDATE_CONFLICT":"The delivery destination update is ambiguous. Send delivery_destination as an object to replace it or null to clear it.","DELIVERY_ELIGIBILITY_CONTEXT_CHANGED":"The checkout delivery eligibility context changed after the request basis was read. Read the current eligibility revision and retry.","DELIVERY_EXPECTED_SELECTION_REQUIRED":"The current delivery selection basis is required. Send the current delivery selection ID, or null when no selection exists.","DELIVERY_EXPECTED_VERSION_INVALID":"The expected_version write fence is not a positive integer. Read the current resource, then retry with its version as expected_version.","DELIVERY_EXPECTED_VERSION_REQUIRED":"This delivery change requires an explicit expected_version write fence. Read the current resource, then retry with its version as expected_version.","DELIVERY_EXTERNAL_REFERENCE_REUSED":"The delivery external reference is already bound to another selection. Reuse the existing selection or submit a new external reference.","DELIVERY_FIELD_NOT_SUPPORTED":"The request includes a field that does not apply to this delivery resource. Remove the field identified by param and retry.","DELIVERY_FIELD_REQUIRED":"The request omits a field required by this delivery resource. Provide the field identified by param and retry.","DELIVERY_GROUPING_UNSUPPORTED":"The delivery obligations cannot form a valid set of buyer choices. Change the assigned delivery profiles, origin policies, or splitting rules before creating another quote.","DELIVERY_MERCHANT_INPUT_REQUIRED":"This delivery input requires merchant authentication. Create the quote from the merchant server with an API key.","DELIVERY_METHODS_NOT_APPLICABLE":"The payment link has no line item that can use a delivery method. Clear delivery_method_ids, or use a catalog-backed line item with an applicable delivery profile.","DELIVERY_METHOD_SERVICE_UNAVAILABLE":"Delivery method assignment is temporarily unavailable. Retry with exponential backoff. Contact support with the request_id if the error persists.","DELIVERY_OPTION_ALREADY_SELECTED":"The selected delivery option belongs to another selection. Read the current selection, then retry with its ID as the compare-and-swap value.","DELIVERY_OPTION_EXPIRED":"The selected delivery option or its guarantee expired. Create a new delivery quote and select a current option.","DELIVERY_OPTION_NOT_IN_CHOICE_GROUP":"The selected option does not belong to the specified choice group. Use an option ID from the same choice group in the quote response.","DELIVERY_PICKUP_AVAILABILITY_CHANGED":"Checkout delivery authority changed during pickup evaluation. Read the current delivery selection and retry with its ID.","DELIVERY_PICKUP_AVAILABILITY_INVALID":"The pickup availability input is invalid. Fix the field identified by the response and retry.","DELIVERY_PICKUP_AVAILABILITY_UNAVAILABLE":"Flint could not construct trustworthy pickup availability evidence. Retry with exponential backoff. Contact support with the request_id if the error persists.","DELIVERY_PICKUP_LOCATION_UNAVAILABLE":"The requested pickup location is not available for the configured delivery methods. Choose a pickup location from the configured collection and retry.","DELIVERY_PREVIEW_INVALID":"The delivery preview input is invalid. Fix the field identified by the response and retry.","DELIVERY_PREVIEW_METHOD_TYPES_INCOMPATIBLE":"The requested methods cannot fulfill at least one line item's allowed fulfillment types. Change delivery_method_ids or line_items[].fulfillment.allowed_types so at least one requested method supports each line item.","DELIVERY_PREVIEW_REQUIRES_CHECKOUT":"The requested preview depends on checkout-only state. Create or update a checkout session, then request a checkout delivery quote.","DELIVERY_PREVIEW_UNAVAILABLE":"Flint could not construct trustworthy cart, routing, or dependency lineage for the preview. Retry with exponential backoff. Contact support with the request_id if the error persists.","DELIVERY_PROFILE_NOT_APPLICABLE":"The selected delivery profile does not apply to the component product type. Use a delivery profile that supports the referenced product type.","DELIVERY_QUOTE_BASIS_INVALID":"The pending quote no longer matches the supplied checkout inputs. Create a new quote from the current checkout inputs.","DELIVERY_QUOTE_EXPIRED":"The delivery quote or one of its options expired. Create a new delivery quote and select a current option.","DELIVERY_QUOTE_INCOMPLETE":"The delivery quote still requires caller input or rates. Supply every input or caller-supplied method result requested by the pending quote.","DELIVERY_QUOTE_INPUT_CHANGED":"The selected destination conflicts with address facts used by the quote. Create a new delivery quote using the selected destination.","DELIVERY_QUOTE_INVALID":"The delivery quote input is invalid. Fix the field identified by the response and retry.","DELIVERY_QUOTE_REVOKED":"The delivery quote was revoked. Create a new quote.","DELIVERY_QUOTE_STALE":"The quote no longer matches the current checkout authority. Create a new delivery quote and retry the selection.","DELIVERY_QUOTE_UNAVAILABLE":"Flint could not calculate a delivery quote. Retry with exponential backoff. Contact support with the request_id if the error persists.","DELIVERY_REQUEST_INVALID":"The delivery request does not satisfy the endpoint contract. Fix the field identified by the response and retry.","DELIVERY_RESOURCE_HAS_DEPENDENCIES":"Active resources depend on this delivery resource. Remove the dependencies described by the response before retrying the lifecycle change.","DELIVERY_RESOURCE_NOT_FOUND":"The delivery resource does not exist in the authenticated merchant environment. Check the resource ID and environment, then retry.","DELIVERY_RESOURCE_VERSION_CONFLICT":"The delivery resource changed before the requested update was committed. Read the current resource version, reapply the intended change, and retry.","DELIVERY_SELECTION_CHANGED":"The current delivery selection changed after the request basis was read. Read the effective selection, create a replacement-basis quote, and retry with its exact selection ID.","DELIVERY_SELECTION_EXPIRED":"The delivery selection expired before payment began. Create a new delivery quote, select a current option, and retry payment.","DELIVERY_SELECTION_INCOMPLETE":"The selection does not choose one option for every choice group. Submit exactly one choice for every choice group in the quote.","DELIVERY_SELECTION_NOT_MUTABLE_AFTER_PAYMENT":"The delivery selection can no longer be changed after payment begins. Read the current order and continue with its committed delivery selection.","DELIVERY_SELECTION_REPLACEMENT_LIMIT":"This checkout reached its protected delivery selection history limit. Finish or restart the checkout. Terminal private payloads become eligible for redaction after their retention period.","DELIVERY_SELECTION_UNAVAILABLE":"Delivery selection is temporarily unavailable. Retry with exponential backoff. Contact support with the request_id if the error persists.","DELIVERY_SERVICE_UNAVAILABLE":"Delivery configuration is temporarily unavailable. Retry with exponential backoff. Contact support with the request_id if the error persists.","DELIVERY_STATE_CONFLICT":"The delivery resource is not in a state that allows the operation. Read the current resource and choose an operation valid for its lifecycle state.","DELIVERY_STATUS_COMBINATION_INVALID":"A delivery status change must be requested separately from other mutable fields. Send status and expected_version in their own PATCH request.","DELIVERY_STATUS_INVALID":"The requested delivery resource status is invalid. Use active or inactive when creating a delivery method.","DELIVERY_WINDOW_EXPIRED":"The selected delivery window expired. Create a new delivery quote and select a current window.","DELIVERY_WINDOW_INVALID":"The selected window was not offered by the chosen delivery option. Use a delivery_window_id from the selected option, or omit it when the option does not require a window.","DEMO_SESSIONS_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","DEMO_SESSION_ROUTE_NOT_ALLOWED":"The demo session key cannot access this route. Use a merchant API key for this route, or call a route supported by demo sessions.","DEMO_SESSION_SECRET_REPLAY_EXPIRED":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","DEVELOPER_MANAGEMENT_REQUIRES_LIVE_KEY":"Developer resource management requires a live API key. Use a live management key from Dashboard, Developers, API keys.","DISCOUNT_AMOUNT_INVALID":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","DISCOUNT_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","DISPUTES_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","DISPUTE_NOT_FOUND":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","DUPLICATE_BUNDLE_COMPONENT_ID":"A bundle component ID appears more than once in the replacement. Include each bundle_component_id only once.","DUPLICATE_CLIENT_OPTION_KEY":"A client option key appears more than once in the create request. Use a unique client_option_key for each option.","DUPLICATE_CLIENT_VALUE_KEY":"A client value key appears more than once within an option. Use a unique client_value_key for each value in the option.","DUPLICATE_CODE":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","DUPLICATE_COMPONENT_VARIANT":"A variant appears more than once in the bundle components. Include each variant_id only once and express the desired count with quantity.","DUPLICATE_IMAGE_EXTERNAL_REFERENCE_ID":"Two images in the gallery use the same external reference ID. Use a unique external_reference_id for each image in the gallery.","DUPLICATE_IMAGE_SOURCE":"The same source URL appears more than once in the gallery. Include each source_url only once in the gallery.","DUPLICATE_INVOICE_LINE":"An invoice line appears more than once in the credit note. Combine the correction into one credit note line per invoice line.","DUPLICATE_OPTION":"An option ID appears more than once in the replacement. Include each option_id only once.","DUPLICATE_OPTION_NAME":"Two product options use the same name. Use a unique name for each product option.","DUPLICATE_OPTION_VALUE":"An option value ID appears more than once in the replacement. Include each option_value_id only once within its option.","DUPLICATE_ORDER_CHARGE_ID":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","DUPLICATE_SCOPE":"The request includes the same scope more than once. Remove the duplicate scope and retry.","DUPLICATE_TAX_BREAKDOWN_REFUND":"The request includes the same tax breakdown more than once. Provide each tax_breakdown_id once.","DUPLICATE_TAX_COMPONENT":"The tax calculation contains duplicate components. Send one component for each jurisdiction code, tax_type, and calculation_type combination.","DUPLICATE_VALUE":"Two values in one product option use the same label. Use a unique value label within each option.","EMAIL_ALREADY_LINKED":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","EMAIL_CHANGE_CONFIRMATION_EXPIRED":"The email change confirmation window expired. Request a new email change confirmation.","EMAIL_CHANGE_CONFIRMATION_INVALID":"The email change confirmation code is invalid. Enter the latest code sent to the new address.","EMAIL_CHANGE_DELIVERY_FAILED":"The email change confirmation could not be delivered. Retry the request. The current customer email remains unchanged.","EMAIL_CHANGE_RATE_LIMITED":"The customer requested too many email changes within 15 minutes. Wait 15 minutes, then retry.","EMAIL_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","EMBEDDED_PAYMENT_RETURN_URL_REQUIRED":"Embedded checkout needs a clean merchant return destination for redirect payment options. Set redirects.success_redirect_url to the HTTPS storefront URL that should recover this checkout.","EMPTY_UPDATE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","ENVIRONMENT_GRANT_NOT_FOUND":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","ENVIRONMENT_LOOKUP_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","ENVIRONMENT_LOOKUP_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","ENVIRONMENT_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","ENVIRONMENT_SELECTION_FORBIDDEN":"The authenticated caller is not authorized for this operation. Use credentials with access to the target merchant, environment, route, and scope, then retry.","EXACTLY_ONE_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","EXPANSION_DEPENDENCY_UNAVAILABLE":"A service required for an accepted expansion is unavailable. Retry with exponential backoff. Contact support with the request_id if the error persists.","EXPANSION_LIMIT_EXCEEDED":"The requested expansion exceeded a route fanout or response-size limit. Request fewer expansions or use follow-up read/list endpoints.","EXPANSION_RESOLUTION_FAILED":"Flint could not resolve an accepted expansion. Retry with exponential backoff. Contact support with the request_id if the error persists.","EXPECTED_VERSION_REQUIRED":"This change requires an explicit expected_version write fence. Read the current resource, then retry with its version as expected_version.","EXPIRED_CARD":"The payment attempt was declined or could not be completed. Use the remediation next_actions and retry only after changing the requested payment inputs.","EXTERNAL_API_KEY_REQUIRED":"The authenticated caller is not authorized for this operation. Use credentials with access to the target merchant, environment, route, and scope, then retry.","EXTERNAL_IMAGE_NOT_ALLOWED":"A transaction image referenced an external URL instead of a Flint-owned canonical image. Ingest the image on an image-bearing resource, then use the untransformed image.url returned by Flint.","EXTERNAL_TAX_COMPONENTS_REQUIRED":"An external tax calculation has no components. Provide at least one component for each taxable line item or charge.","FEEDBACK_REPORTS_UNAVAILABLE":"Feedback reports are temporarily unavailable. Retry with exponential backoff and the same idempotency key when creating a report.","FEEDBACK_REPORT_NOT_FOUND":"The feedback report was not found in this merchant environment. Check the feedback report ID and use a credential for the environment that created it.","FIELD_NOT_ALLOWED_FOR_CALLER":"The authenticated caller is not allowed to set this field or value. Remove the field or use a caller authorized for that operation, then retry.","FIELD_NOT_UPDATABLE":"This field cannot be set for this operation. Remove the field identified by the response and retry.","FIELD_REQUIRED":"A required request field is missing. Supply the field named by param and retry.","FIRST_NAME_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","FLAT_TAX_PAYMENT_ATTRIBUTION_UNAVAILABLE":"The flat tax is not fully attributable to refundable payment settlements. Read the order payment state and retry after every payment settlement is available.","FLAT_TAX_PRICE_MODE_INVALID":"A flat tax component uses an unsupported price mode. Set price_mode to additive for a flat_amount component.","FLAT_TAX_REFUND_MUST_BE_FULL":"A flat tax must be refunded for its full remaining amount or omitted. Set tax_money to the full remaining flat tax amount, or omit this tax breakdown.","FLAT_TAX_REFUND_STATE_INVALID":"Stored flat-tax refund lineage is inconsistent with whole-or-nothing reversal. Contact support with the request_id so Flint can repair the refund lineage.","FLAT_TAX_SCOPE_INVALID":"A flat tax component was assigned to a line item or charge. Move flat tax components to the order-level tax calculation, or use a percentage component for the line item or charge.","FRAUD_WARNING_NOT_FOUND":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","FULFILLMENT_ACTION_NOT_ALLOWED":"The fulfillment cannot perform the requested action from its current state. Read current_resource.supported_actions and choose one of the listed actions.","FULFILLMENT_APPROVAL_REQUIRED":"This fulfillment requires explicit merchant approval before work begins. Accept the fulfillment, then advance it into preparation, movement, or completion.","FULFILLMENT_BUNDLE_UNSUPPORTED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","FULFILLMENT_CHANGED":"The fulfillment changed after the submitted version was read. Read the current fulfillment and retry with its version as expected_version.","FULFILLMENT_COMPLETED":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","FULFILLMENT_CONFIGURATION_ACTION_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","FULFILLMENT_EVENT_SUBJECT_INVALID":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","FULFILLMENT_PROFILE_REQUIRED":"The bundle component needs a delivery profile. Set delivery_profile_id to an applicable active profile.","FULFILLMENT_PROFILE_REVISION_UNUSABLE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","FULFILLMENT_PROFILE_UNAVAILABLE":"The delivery profile is not available. Use an active delivery profile in the same environment, or omit delivery_profile_id when the catalog default applies.","FULFILLMENT_QUANTITY_EFFECT_REQUIRED":"A failed fulfillment must say whether to release its quantity. Set release_quantity to true to release the items or false to preserve them, then retry.","FULFILLMENT_REASON_INVALID":"The fulfillment transition reason is not valid for this action. Use one of the reason values documented for the action and retry.","FULFILLMENT_REQUIREMENT_REQUIRED":"An ad-hoc line item is missing its explicit fulfillment requirement. Provide the line item's fulfillment object and retry.","FULFILLMENT_SCHEDULE_NOT_ALLOWED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","FULFILLMENT_SCHEDULE_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","FULFILLMENT_SELECTION_REQUIRED":"This checkout requires a delivery selection before payment can begin. Create a current delivery quote, select one option for every choice group, then retry payment.","FULFILLMENT_STATUS_REASON_TOO_LONG":"The fulfillment transition reason exceeds the supported length. Use a reason no longer than 500 characters.","FULFILLMENT_TERMINAL":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","FULFILLMENT_TYPE_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","HOSTED_INSTALL_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","IDEMPOTENCY_CLEAR_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","IDEMPOTENCY_KEY_IN_PROGRESS":"A request with the same idempotency key is still in progress. Wait briefly and retry with the same idempotency key.","IDEMPOTENCY_KEY_REQUIRED":"This operation requires an idempotency key. Send a unique Idempotency-Key header and reuse it for retries of the same logical operation.","IDEMPOTENCY_KEY_REUSED":"The idempotency key was reused with a different request body. Use the original request body with this idempotency key, or generate a new idempotency key for a new operation.","IDEMPOTENCY_KEY_TOO_LONG":"The idempotency key exceeds the supported length. Send an Idempotency-Key header no longer than 255 characters.","IDEMPOTENCY_LOAD_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","IDEMPOTENCY_PERSIST_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","IDEMPOTENCY_RECORD_INVALID":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","IDEMPOTENCY_RECOVERY_REQUIRED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","IDEMPOTENCY_REQUEST_IN_PROGRESS":"The payment-link resolution with this context and idempotency key is still in progress. Wait briefly and retry with the same resolution_context and Idempotency-Key.","IDENTITY_RESOLUTION_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","IMAGE_ANIMATION_UNSUPPORTED":"The image source is animated, but Flint accepts still images only. Provide a still JPEG, PNG, or WebP image, then retry.","IMAGE_ASSET_NOT_ATTACHABLE":"The canonical image has expired or was deleted. Re-supply the original source_url on a catalog or branding resource.","IMAGE_ASSET_NOT_FOUND":"The canonical image does not exist in the authenticated merchant and environment, or is not attachable. Use an untransformed image.url returned for this merchant and environment, then retry.","IMAGE_DIMENSIONS_EXCEEDED":"The image dimensions exceed Flint's axis or pixel limits. Resize the source to at most 12,000 pixels per axis and 40 megapixels, then retry.","IMAGE_FORMAT_UNSUPPORTED":"The image format is unsupported or malformed. Provide a valid still JPEG, PNG, or WebP image, then retry.","IMAGE_GALLERY_LIMIT_EXCEEDED":"The requested gallery contains more than eight images. Send no more than eight images in the gallery.","IMAGE_INGESTION_COUNT_EXCEEDED":"The mutation contains more external image ingestions than one request allows. Split the change into mutations containing at most 32 external image sources.","IMAGE_INGESTION_EXPIRED":"The prior image ingestion expired and its reserved storage was cleaned up. Retry the request with a new idempotency key.","IMAGE_INGESTION_IN_PROGRESS":"The same image ingestion step is still running. Wait briefly, then retry with the same idempotency key and request body.","IMAGE_INGESTION_RESTART_REQUIRED":"The prior image ingestion attempt ended and cannot be resumed. Wait briefly for cleanup, then start a new ingestion with a new idempotency key.","IMAGE_NOT_ATTACHABLE":"The image cannot be attached to this resource. Use an attachable image returned for the same merchant and environment, then retry.","IMAGE_OWNER_NOT_MUTABLE":"The resource no longer accepts image changes. Retrieve the resource and update images only while the resource is mutable.","IMAGE_PIXEL_BUDGET_EXCEEDED":"The mutation exceeds the total decoded image pixel budget. Resize the sources or split the images across smaller mutations.","IMAGE_PROCESSING_CAPACITY_EXCEEDED":"Image processing capacity is temporarily exhausted. Retry with exponential backoff. If remediation says to start a new ingestion, use a new idempotency key.","IMAGE_PROCESSING_FAILED":"The image could not be decoded or processed safely. Replace an invalid source. If remediation says to start a new ingestion, use a new idempotency key.","IMAGE_PROCESSING_TIMEOUT":"Image processing exceeded its deadline. Retry with exponential backoff and a new idempotency key when remediation says to start a new ingestion.","IMAGE_REVISION_MISMATCH":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","IMAGE_SOURCE_FETCH_FAILED":"The source did not return a complete supported image response. Check the source response, redirects, encoding, and content length, then retry.","IMAGE_SOURCE_NOT_PUBLIC":"The source URL does not resolve to an allowed public origin. Use a public HTTPS origin that does not resolve to private, loopback, link-local, or Flint infrastructure addresses.","IMAGE_SOURCE_TIMEOUT":"The source host did not return the image before the fetch deadline. Retry with exponential backoff and a new idempotency key when remediation says to start a new ingestion, or use a more reliable source host.","IMAGE_SOURCE_TOO_LARGE":"The source image exceeds the 5 MB byte limit. Reduce the source file below 5 MB, then retry.","IMAGE_SOURCE_UNAVAILABLE":"The source host was temporarily unavailable. Retry with exponential backoff and a new idempotency key when remediation says to start a new ingestion.","IMAGE_SOURCE_URL_INVALID":"The image source URL violates Flint's HTTPS source rules. Use an HTTPS URL on port 443 without credentials or a fragment.","IMAGE_STORAGE_QUOTA_EXCEEDED":"The merchant's stored image bytes have reached the configured quota. Remove unused image attachments or wait until ready unattached images expire, then retry.","IMAGE_URL_INVALID":"The submitted image URL is invalid. Use the exact untransformed image.url returned by Flint.","IMAGE_URL_MUST_BE_CANONICAL":"The image URL is a transformed delivery URL instead of the canonical asset URL. Use the exact image.url returned by Flint without a variant path, query, or fragment.","INCORRECT_CVC":"The payment attempt was declined or could not be completed. Use the remediation next_actions and retry only after changing the requested payment inputs.","INITIAL_API_KEY_ALREADY_CREATED":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","INSUFFICIENT_AVAILABLE_BALANCE":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","INSUFFICIENT_FUNDS":"The payment attempt was declined or could not be completed. Use the remediation next_actions and retry only after changing the requested payment inputs.","INSUFFICIENT_SCOPE":"The API key is missing a required scope. Create or use an API key with the required scope, then retry the request.","INTERNAL_ERROR":"Flint returned an internal server error. Retry with exponential backoff. Contact support with the request_id if the error persists.","INTERVAL_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_ACTION":"The request action is not supported by this operation. Use one of the documented action values and retry.","INVALID_ACTIONABLE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_ACTIVITY_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_ALLOCATION":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_AMOUNT":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_API_KEY":"The API key credential is malformed or invalid. Check the API key value or create a new API key, then retry.","INVALID_API_VERSION":"The requested API version is not supported. Set Flint-Version to a supported version listed in the error details.","INVALID_APPLICATION_METHOD":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_AUTHORIZATION_HEADER":"The Authorization header is malformed or uses an unsupported credential. Send a Flint API key or partner install token as Authorization: Bearer \u003ctoken\u003e, or use X-API-Key for API keys.","INVALID_BALANCE_SOURCE_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_BEARER_TOKEN":"The request could not be authenticated. Send a valid Flint credential supported by this endpoint, then retry.","INVALID_BILLING_ANCHOR_DAY":"The billing anchor day is outside the supported range. Set billing_anchor_day to a day from 1 through 31.","INVALID_BILLING_INTERVAL":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_BILLING_SCHEDULE_OWNER":"The billing schedule owner is not supported. Use flint or external.","INVALID_BOOLEAN":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_BOOTSTRAP_SCOPES":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_BUNDLE_STATUS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_CALCULATION_BASIS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_CANCELLATION_REASON":"The cancellation reason is not in the supported public vocabulary. Use requested_by_customer, duplicate, fraudulent, or abandoned as allowed for the caller.","INVALID_CAPTURE_AMOUNT":"The requested capture amount is invalid. Send a positive amount in the authorization currency, or omit amount_money to capture the available authorization.","INVALID_CAPTURE_METHOD":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_CASE_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_CATEGORIES":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_CATEGORY_DESCRIPTION":"The category description is invalid. Provide a description with at most 2,048 characters, or omit it.","INVALID_CATEGORY_HANDLE":"The category handle is invalid. Use lowercase letters and numbers separated by single hyphens.","INVALID_CATEGORY_NAME":"The category name is invalid. Provide a category name with 1 through 100 characters.","INVALID_CATEGORY_STATUS":"The category status filter is invalid. Use active or archived.","INVALID_CHANNEL":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_CHARGE_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_CHARGE_VALUE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_CHECKOUT_SESSION":"The request could not be authenticated. Send a valid Flint credential supported by this endpoint, then retry.","INVALID_CHECKOUT_SURFACE":"The checkout surface is invalid. Send surface as hosted or embedded.","INVALID_CODE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_COMPLETION_BEHAVIOR":"The order payment completion behavior is invalid. Use complete_order or partial_payment and retry.","INVALID_COMPONENT":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_COMPONENTS":"The bundle component collection is invalid. Send components as an array, or omit it to leave components unchanged.","INVALID_COMPONENT_POSITION":"The bundle component position is invalid. Use a position of zero or greater.","INVALID_COMPONENT_QUANTITY":"The bundle component quantity is outside the supported range. Use a quantity from 1 through 9999.","INVALID_COUNTRY":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_CREATED_AFTER":"created_after is not a valid RFC 3339 timestamp. Send an RFC 3339 timestamp or omit created_after.","INVALID_CREATED_BEFORE":"created_before is not a valid RFC 3339 timestamp. Send an RFC 3339 timestamp or omit created_before.","INVALID_CREATED_RANGE":"created_before must not be earlier than created_after. Correct the creation-time range and retry.","INVALID_CREDIT_NOTE_CORRECTION_TYPE":"The credit note correction type is invalid. Use quantity or amount.","INVALID_CREDIT_NOTE_LINE":"A credit note line is invalid. Use a positive correction within the frozen invoice line's remaining amount or quantity.","INVALID_CREDIT_NOTE_MEMO":"The credit note memo exceeds the supported length. Use a memo no longer than 4096 characters.","INVALID_CREDIT_NOTE_REASON":"The credit note reason is invalid. Use returned_goods, order_adjustment, billing_error, goodwill, or other.","INVALID_CREDIT_NOTE_STATUS":"The credit note status filter is invalid. Use draft, issued, or void.","INVALID_CURRENCY":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_CURSOR":"The webhook stream resume event ID is malformed. Use a webhook_event_id previously returned by the stream, or omit the resume value.","INVALID_CUSTOMER_ACCOUNT_REQUEST":"A customer account resource request is invalid. Correct the invalid fields and retry.","INVALID_CUSTOMER_SESSION":"The customer session request contains an invalid lifetime or omits its customer. Fix the field described by the error and retry.","INVALID_DEFAULT_FOR_CURRENCY":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_DELAY_DAYS_OVERRIDE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_DELIVERY_CONFIGURATION_STATUS":"The delivery configuration status filter is invalid. Use configured or action_required.","INVALID_DELIVERY_EVALUATION_STATUS":"evaluation_status is not a supported delivery quote evaluation status. Use complete, incomplete, or degraded.","INVALID_DELIVERY_MODE":"The invoice delivery mode is invalid. Use merchant_default, email, or caller_managed.","INVALID_DELIVERY_OPTION_DETAILS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_DELIVERY_OPTION_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_DELIVERY_PROFILE_ID":"The delivery profile ID is invalid. Use a valid dprof_ ID.","INVALID_DELIVERY_QUOTE_STATUS":"status is not a supported delivery quote status. Use active, consumed, stale, expired, or revoked.","INVALID_DELIVERY_STATUS":"The requested webhook delivery status is not supported. Use pending, delivered, failed, or suppressed and retry.","INVALID_DIGITAL_WALLET":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_DISCOUNT":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_DISCOUNT_CALCULATION_BASIS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_DISCOUNT_CLASS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_DISCOUNT_SCOPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_DISPUTE_REQUEST":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_DOMAIN_NAME":"The payment method domain name is not an exact fully-qualified hostname. Send one domain or subdomain without a scheme, path, port, IP address, or wildcard.","INVALID_DONATION_AMOUNT":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_ENVIRONMENT_SELECTION":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_EVENT_AT":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_EVENT_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_EXCLUSIVITY_SELECTION":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_EXPAND":"The request included an invalid or unsupported expand path. Fix or remove the requested expand path; use only supported values documented for the route.","INVALID_EXPECTED_VERSION":"The expected_version is missing or invalid. Send a positive version from the current resource.","INVALID_EXPIRES_AT":"The request included an invalid or past expiration timestamp. Send expires_at as a future RFC3339 timestamp, or omit it for a non-expiring key.","INVALID_EXTERNAL_REFERENCE_ID":"The external reference ID has an invalid length. Use an external_reference_id of at most 255 characters, or omit it.","INVALID_FEEDBACK_KIND":"The feedback kind is not supported. Use one of the feedback kinds documented for feedback reports.","INVALID_FEEDBACK_SHAPE":"The feedback fields do not match the selected kind. Provide the required fields for the selected feedback kind and remove fields that do not apply.","INVALID_FEEDBACK_SURFACE":"The feedback surface is not supported. Use one of the documented Flint surfaces.","INVALID_FIELD_TYPE":"The request payload contains a field with the wrong JSON type. Send the field using the documented JSON type, then retry with the same idempotency key if this was the same logical operation.","INVALID_FLAT_MONEY":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_FLAT_TAX":"The flat tax amount or currency is invalid. Send a positive flat_money amount in the order currency.","INVALID_FULFILLMENT_BUYER_NOTIFICATION_BEHAVIOR":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_FULFILLMENT_DETAILS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_FULFILLMENT_EVENT_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_FULFILLMENT_QUANTITY_EFFECT":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_FULFILLMENT_REQUIREMENT":"The inline fulfillment requirement is invalid. Fix the identified fulfillment field and retry.","INVALID_FULFILLMENT_SHIPMENT_STATUS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_FULFILLMENT_STATUS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_FULFILLMENT_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_HAS_PLAN":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_ID":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_IDEMPOTENCY_KEY":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_IMAGE_ALT":"The image alt text exceeds the supported length. Shorten alt to 512 characters or fewer, then retry.","INVALID_IMAGE_EXTERNAL_REFERENCE_ID":"The image external reference ID has an invalid length. Use a non-empty external_reference_id of at most 255 characters, or omit it.","INVALID_IMAGE_GALLERY":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_INCLUDE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_INCLUDE_DELETED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_INTERVAL":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_INTERVAL_END_AT":"The report interval end is invalid. Use an RFC 3339 instant for interval_end_at.","INVALID_INTERVAL_START_AT":"The report interval start is invalid. Use an RFC 3339 instant for interval_start_at.","INVALID_INVOICE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_INVOICE_COLLECTION":"The invoice collection input contains fields that do not apply to its mode. Send only the fields supported by the selected collection mode.","INVALID_INVOICE_COLLECTION_MODE":"The invoice collection mode is invalid. Use merchant_default, buyer_initiated, automatic, or external.","INVALID_INVOICE_DRAFT_SOURCE":"The invoice draft source is invalid. Provide exactly one valid order_id or quick_pay source.","INVALID_INVOICE_LATE_FEE_AMOUNT":"The calculated late fee is zero or exceeds the supported balance. Review the frozen policy and current principal balance.","INVALID_INVOICE_LATE_FEE_REASON":"The waiver reason is missing or too long. Provide a reason between 1 and 4096 characters.","INVALID_INVOICE_LATE_FEE_SCHEDULE":"The schedule entry does not match the invoice. Provide an entry from the scheduled invoice, or omit it for an unscheduled invoice.","INVALID_INVOICE_PAYMENT_DUE":"The invoice payment due input does not match its due type. Provide the fields required by the selected type and remove fields that do not apply.","INVALID_INVOICE_PAYMENT_DUE_TYPE":"The invoice payment due type is invalid. Use none, absolute, payment_terms, customer_default, or merchant_default.","INVALID_INVOICE_PAYMENT_POLICY":"The invoice payment policy is invalid. Use supported payment options and valid per-option limits.","INVALID_INVOICE_PAYMENT_TERM":"The invoice payment term is invalid. Correct the calculation or late fee fields and retry.","INVALID_JSON":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry with the same idempotency key if this was the same logical operation.","INVALID_LAUNCH_TOKEN":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_LINE_ITEM":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_LINE_ITEMS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_MAX_AMOUNT":"The max_amount filter is not a single positive integer in minor units. Send max_amount once as a positive integer in minor units and include its three-letter currency, then retry.","INVALID_METADATA":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_METADATA_KEY":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_METHOD":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_MINIMUM_BALANCE_AMOUNT":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_MINIMUM_BALANCE_BY_CURRENCY":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_MINIMUM_BALANCE_CURRENCY":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_MIN_AMOUNT":"The min_amount filter is not a single positive integer in minor units. Send min_amount once as a positive integer in minor units and include its three-letter currency, then retry.","INVALID_MODE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_MODIFIER":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_MODIFIER_GROUP":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_MODIFIER_GROUP_STATUS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_MODIFIER_GROUP_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_MODIFIER_SET":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_MODIFIER_SET_ID":"modifier_set_id is not a valid modifier set ID. Send an ms_ ID returned by the modifier set API, or null to clear the attachment.","INVALID_MODIFIER_SET_STATUS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_MODIFIER_STATUS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_MONEY":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_MONTHLY_PAYOUT_DAY":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_NOTIFICATION_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_ONBOARDING_SESSION":"The request could not be authenticated. Send a valid Flint credential supported by this endpoint, then retry.","INVALID_OPTIONS":"The product option collection is invalid. Send options as an array, or omit it to leave options unchanged.","INVALID_OPTION_POSITION":"The product option position is invalid. Use a position of zero or greater.","INVALID_OPTION_STATUS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_OPTION_VALUE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_OPTION_VALUE_POSITION":"The product option value position is invalid. Use a position of zero or greater.","INVALID_OPTION_VALUE_STATUS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_ORDER_STATUS":"The order cannot be changed in its current status. Read the order and retry only while its status permits this change.","INVALID_ORIGIN":"The requested origin is not supported. Use a documented origin value and retry.","INVALID_PACKAGING":"The shipment packaging choice is missing or unsupported. Set shipment.packaging to single_package.","INVALID_PAGE_SIZE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_PAGE_TOKEN":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_PARTNER_APP":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_PARTNER_TOKEN":"The partner install token is invalid or expired. Refresh or reinstall the partner app authorization, then retry with a valid partner install token.","INVALID_PAYMENTS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_PAYMENT_INTENT_STATE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_PAYMENT_LINK_CUSTOM_FIELD_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_PAYMENT_LINK_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_PAYMENT_METHOD_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_PAYMENT_OPTIONS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_PAYMENT_OPTION_RESOLVE_REQUEST":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_PAYMENT_STATUS":"The requested payment status is not supported. Use unpaid, partially_paid, or paid and retry.","INVALID_POLICY_COMBINATION":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_PRODUCT_CREATE_SHAPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_PRODUCT_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_QUERY":"The query value has an invalid length. Use a query of at most 255 characters, or omit it.","INVALID_QUERY_PARAMETER":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_RANGE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_REASON":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_RECIPIENT":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_RECURRENCE_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_REDEMPTION_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_REFUND_ADJUSTMENT_APPLIES_TO":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_REFUND_ADJUSTMENT_REASON_CODE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_REFUND_ADJUSTMENT_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_REFUND_METHOD":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_REFUND_REASON":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_REFUND_STATUS":"The requested refund status is not supported. Use none, partially_refunded, or refunded and retry.","INVALID_RELATED_OBJECT_ID":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_RELATED_REQUEST_ID":"The related request ID is not valid. Use a Flint request ID from the response or request logs.","INVALID_RELATED_RESOURCE_ID":"A related resource ID is not a supported Flint public resource. Use a public Flint resource ID returned by the API.","INVALID_REPORT_INTERVAL":"The report interval is invalid. Set interval_end_at after interval_start_at.","INVALID_REPORT_TYPE":"The report type is not supported. Use a report_type listed in the reports reference.","INVALID_REQUEST":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_REQUEST_BODY":"The request body is invalid. Send valid JSON that matches the request schema and contains no unknown fields.","INVALID_RESOURCE_ID":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_RESOURCE_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_REWARD_SELECTION":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_ROLE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_RULE_GROUP":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_RULE_OPERATOR":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_RULE_VALUE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_SANDBOX_ID":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_SCOPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_SHIPMENT_DIRECTION":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_SHIPMENT_PACKAGE_STATUS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_SORT_BY":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_SORT_DIRECTION":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_SORT_FIELD":"The requested subscription sort field is not supported. Use created_at, updated_at, or next_billing_at.","INVALID_SOURCE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_SOURCE_CONTEXT":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_STACKING_MODE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_STATEMENT_DESCRIPTOR":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_STATUS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_STATUS_BUCKET":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_SUBSCRIPTION_PLAN_LINE_ITEM_ID":"The item ID does not identify an item on this plan. Use a subscription_plan_line_item_id from this plan, or omit the ID to create an item.","INVALID_SURFACE_ROUTE":"The surface route is not a canonical public API route. Use the documented route template without a host, query string, or concrete resource ID.","INVALID_TAX_ADJUSTMENT_AUDIT_ACTOR_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_TAX_ADJUSTMENT_REASON_CODE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_TAX_CALCULATION_TYPE":"The tax component calculation type is invalid. Use percentage for a line item or charge, or flat_amount for an order-scoped component.","INVALID_TAX_CATEGORY":"The tax category is invalid for this taxable item or charge. Use a documented Flint tax category for the field identified by param.","INVALID_TAX_JURISDICTION":"The external tax jurisdiction is invalid. Provide a US jurisdiction with a valid code, two-letter state, level, and name.","INVALID_TAX_MODE":"The tax calculation mode is invalid. Set mode to automatic or external.","INVALID_TAX_PERCENTAGE":"A tax percentage is outside the supported range or precision. Set percentage from 0 through 100 with no more than four decimal places.","INVALID_TAX_PRICE_MODE":"The tax price mode is invalid. Set price_mode to additive or inclusive.","INVALID_TAX_REFUND_MODE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_TAX_TYPE":"The tax component type does not match its calculation type. Use sales_tax or use_tax with percentage, and retail_delivery_fee with flat_amount.","INVALID_TEMPLATE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_TIMESTAMP":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_TIMEZONE":"The report timezone is invalid. Use an IANA timezone name such as America/New_York.","INVALID_TIP":"The requested tip must use one value type. Send exactly one of amount_money or percent.","INVALID_TIP_AMOUNT":"The requested tip amount is invalid. Send a positive amount in minor units.","INVALID_TIP_PERCENT":"The requested tip percentage is invalid. Send percent from 1 through 100 with no more than four decimal places.","INVALID_TOTALS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_TRANSACTION_PURPOSE":"The transaction purpose is not supported. Use goods, services, or other and retry.","INVALID_UPDATED_AFTER":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_UPDATED_BEFORE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_UPDATE_MASK":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_VARIANT_STATUS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_VERIFICATION":"The request could not be authenticated. Send a valid Flint credential supported by this endpoint, then retry.","INVALID_WEBHOOK_ENDPOINT":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVALID_WEBSITE_URL":"The merchant website URL is not valid for account onboarding. Send the merchant's real, publicly reachable business website URL in profile.website_url, then retry.","INVALID_WEEKLY_PAYOUT_DAY":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVENTORY_ADJUSTMENT_NOT_FOUND":"The inventory adjustment was not found in this merchant environment. Check the inventory adjustment ID and environment.","INVENTORY_ALLOCATION_POLICY_IN_USE":"The inventory allocation policy has active reservations. Close or move the active reservations before making the policy inactive.","INVENTORY_CHANGED":"The inventory basis changed before the mutation committed. Read the current version or routing basis and retry with a new idempotency key when the logical request changes.","INVENTORY_CONDITION_INVALID":"The requested inventory quantities violate a physical-condition invariant. Correct the condition quantities and retry.","INVENTORY_COUNT_CHANGED":"The inventory count version, lifecycle state, or captured physical revision changed. Read the current count and level revisions, then retry if its state still allows the operation.","INVENTORY_COUNT_NOT_FOUND":"The inventory count was not found in this merchant environment. Check the inventory count ID and environment.","INVENTORY_COUNT_PHYSICAL_REVISION_CHANGED":"Physical stock at this level changed after the count captured it. Recount the affected inventory item at this location, then submit the observation again.","INVENTORY_DEMAND_DUPLICATE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVENTORY_DEMAND_INVALID":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVENTORY_EVENT_PROVENANCE_INVALID":"The physical inventory event provenance is structurally invalid. Correct the event time, source system, external source, actor, or observation sequence and retry.","INVENTORY_INSUFFICIENT":"Current eligible inventory cannot satisfy the complete demand. Change demand, replenish stock, or change the routing source before retrying.","INVENTORY_ITEM_IN_USE":"The inventory item has active dependencies. Remove the reported catalog, level, reservation, or transfer dependencies before making it inactive or retiring it.","INVENTORY_ITEM_NOT_FOUND":"The inventory resource was not found in this merchant environment. Check the resource ID and environment.","INVENTORY_ITEM_UNAVAILABLE":"The inventory item does not accept new sale or routing use. Activate the item or use another active inventory item.","INVENTORY_LEVEL_NOT_FOUND":"The inventory level was not found in this merchant environment. Check the inventory level ID and environment.","INVENTORY_LOCATION_ALLOCATION_INACTIVE":"The Location inventory capability rejects new claims. Activate allocation for the Location or choose another Location.","INVENTORY_LOCATION_NOT_CONFIGURED":"The Location does not have an active inventory capability. Configure and activate the Location inventory capability.","INVENTORY_MOVEMENT_NOT_FOUND":"The inventory movement was not found in this merchant environment. Check the inventory movement ID and environment.","INVENTORY_POLICY_INVALID":"The allocation policy request is structurally invalid. Correct the policy groups, ordering, splitting behavior, or limits and retry.","INVENTORY_POLICY_NOT_FOUND":"The inventory allocation policy was not found in this merchant environment. Check the inventory allocation policy ID and environment.","INVENTORY_QUANTITY_CONFLICT":"The requested reservation transition exceeds the eligible quantity. Read the reservation lines and submit cumulative targets within the active quantities.","INVENTORY_RECEIPT_CONFLICT":"The inventory receipt conflicts with current inventory lineage. Read the linked consumed quantities and retry with a valid remaining return quantity.","INVENTORY_RECEIPT_INVALID":"The inventory receipt request is structurally invalid. Correct the receiving Location, disposition, lineage, and quantities and retry.","INVENTORY_RECEIPT_NOT_FOUND":"The inventory receipt was not found in this merchant environment. Check the inventory receipt ID and environment.","INVENTORY_RESERVATION_EXISTS":"The owner slot already has an active reservation. Read or replace the active reservation identified by the conflict details.","INVENTORY_RESERVATION_EXPIRED":"The reservation is no longer an active stock claim. Create a new route-and-hold reservation.","INVENTORY_RESERVATION_NOT_FOUND":"The inventory reservation was not found in this merchant environment. Check the inventory reservation ID and environment.","INVENTORY_RESERVATION_OWNER_MISMATCH":"The caller cannot mutate this reservation owner type. Use the workflow that owns the reservation.","INVENTORY_ROUTING_SOURCE_INVALID":"The inventory routing source does not match a supported branch. Send exactly one valid fixed Location, allocation policy, or immutable policy version reference.","INVENTORY_ROUTING_SOURCE_REQUIRED":"Tracked demand requires an explicit inventory routing source. Use line items that do not track inventory, or create an order with a fixed Location, active policy, or immutable policy version.","INVENTORY_ROUTING_TOO_COMPLEX":"The routing request exceeds a published structural limit. Reduce the number of demand lines, assignment edges, policy Locations, or split Locations and retry.","INVENTORY_ROUTING_UNAVAILABLE":"A required routing dependency could not calculate authoritative ordering evidence. Retry after the routing dependency recovers.","INVENTORY_SHORTAGE":"The requested committed quantity is not protected by physical stock. Replenish, release, cancel, or explicitly reallocate the affected claim.","INVENTORY_SOURCE_SEQUENCE_CHANGED":"The physical observation sequence is stale or conflicting. Read the accepted source sequence and submit a strictly newer absolute observation.","INVENTORY_TRANSFER_ACTION_NOT_ALLOWED":"The requested inventory transfer action is not available. Choose an action from supported_actions and retry with the current version.","INVENTORY_TRANSFER_CHANGED":"The inventory transfer version or lifecycle state changed. Read the current transfer and retry if its state still allows the operation.","INVENTORY_TRANSFER_INVALID":"The inventory transfer request is structurally invalid. Correct the Locations, lines, physical conditions, or cumulative targets and retry.","INVENTORY_TRANSFER_NOT_FOUND":"The inventory transfer was not found in this merchant environment. Check the inventory transfer ID and environment.","INVENTORY_UNAVAILABLE":"Stock could not be held for this order's tracked line items. Check availability for the order's routing source, then replenish, widen the allocation policy, or reduce the quantity.","INVOICE_ACCESS_AUTH_UNAVAILABLE":"Invoice access authentication is temporarily unavailable. Retry with exponential backoff. Contact support with the request_id if the error persists.","INVOICE_AUTOPAY_PAYMENT_METHOD_REQUIRED":"Automatic invoice collection has no saved card to charge. Set collection.payment_method_id or configure a default card for the customer.","INVOICE_AUTOPAY_PAYMENT_METHOD_UNSUPPORTED":"Automatic invoice collection requires a reusable saved card. Choose an active reusable card that belongs to the invoice customer.","INVOICE_BALANCE_CHANGED":"The invoice balance changed after the payment request was prepared. Refresh the invoice and rebuild the payment selection from its current collectible balance.","INVOICE_CHECKOUT_REPLACEMENT_NOT_ALLOWED":"Invoice-owned checkout sessions cannot be replaced through generic checkout creation. Use the invoice checkout-session endpoint to manage collection for an invoiced order.","INVOICE_COLLECTION_BLOCKED":"Invoice collection is blocked until inventory is available. Resolve the inventory block, then retry.","INVOICE_COLLECTION_CHANGED":"The invoice collection state changed after the request was prepared. Refresh the invoice, then rebuild the request from its current state.","INVOICE_COLLECTION_MODE_UNSUPPORTED":"The invoice collection mode does not support this payment flow. Use hosted checkout for buyer_initiated invoices or POST /collect for automatic invoices.","INVOICE_DRAFT_CHANGED":"The invoice changed before this update completed. Retrieve the invoice and retry with its current version as expected_version.","INVOICE_HAS_ISSUED_CREDIT_NOTE":"The invoice has an issued credit note. Void the issued credit note before voiding the invoice.","INVOICE_ISSUE_IN_PROGRESS":"Invoice issue state changed before the request could complete. Retry with the same Idempotency-Key.","INVOICE_LATE_FEE_NOT_COLLECTIBLE":"The invoice has no eligible balance for this action. Use an open or partially paid invoice with unpaid principal for assessment or an unpaid fee for waiver.","INVOICE_LATE_FEE_NOT_DUE":"The late fee grace period has not elapsed. Wait until the invoice due date and frozen grace period have passed.","INVOICE_LATE_FEE_NOT_FOUND":"The invoice late fee was not found. Use a fee ID returned by this invoice in the selected environment.","INVOICE_LATE_FEE_POLICY_REQUIRED":"The invoice has no frozen late fee policy. Assess fees only on invoices issued with a late fee policy.","INVOICE_LINK_UNAVAILABLE":"The invoice has no active public link, so hosted collection or link delivery cannot proceed. Regenerate the invoice public link, then retry.","INVOICE_LOCKED_ORDER_FINANCIALS":"An active invoice controls the order's financial fields. Void the active invoice before changing the order's financial fields.","INVOICE_NOT_COLLECTIBLE":"The invoice is not open or partially paid with a balance remaining. Collect only open or partially_paid invoices with a positive outstanding_money.","INVOICE_NOT_CREDITABLE":"The invoice cannot receive a credit note in its current state. Use an issued invoice that has not been voided.","INVOICE_NOT_DRAFT":"Only draft invoices can be issued. Read the current invoice instead of issuing it again.","INVOICE_NOT_FOUND":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","INVOICE_NOT_ISSUED":"The invoice has not been issued and has no public link. Issue the invoice before managing its public link.","INVOICE_NOT_MARKABLE_UNCOLLECTIBLE":"The invoice cannot be marked uncollectible in its current state. Use an open or partially_paid invoice with a positive outstanding balance and no active payment attempt.","INVOICE_NOT_REVERSIBLE":"The invoice payment cannot be reversed. Check the payment and invoice state before retrying.","INVOICE_NOT_VOIDABLE":"The invoice cannot be voided in its current state. Void only an unpaid draft or open invoice.","INVOICE_PAYMENT_ALREADY_SETTLED":"The invoice payment settled before cancellation completed. Read the settled attempt and current invoice.","INVOICE_PAYMENT_ATTEMPT_ACTIVE":"An invoice payment attempt is open. Wait for it to finish or cancel it before retrying.","INVOICE_PAYMENT_FAILED":"The invoice payment failed. Read the payment attempt, then direct the buyer to the invoice public URL or retry with a new Idempotency-Key.","INVOICE_PAYMENT_METHOD_FROZEN":"The supplied card differs from the card frozen when the invoice was issued. Omit payment_method_id or send the frozen card ID.","INVOICE_PAYMENT_OPTIONS_REQUIRED":"Buyer-initiated collection requires at least one payment option. Enable a supported payment option in collection.payment_policy.","INVOICE_PAYMENT_PROCESSING":"An invoice payment attempt is processing. Wait for it to settle, fail, or be canceled before retrying.","INVOICE_PAYMENT_RESOLVING":"Invoice payment work is still resolving, so competing collection or mutation cannot proceed yet. Wait briefly, then retry the same request after the payment attempt converges.","INVOICE_PAYMENT_TERM_CHANGED":"The invoice payment term changed before this update completed. Fetch the payment term and retry the update.","INVOICE_PAYMENT_TERM_IN_USE":"The invoice payment term is still used as a default. Remove it from merchant and customer defaults, then retry.","INVOICE_PAYMENT_TERM_UNAVAILABLE":"The selected invoice payment term is not active for this merchant environment. Choose an active invoice payment term and retry.","INVOICE_PDF_UNAVAILABLE":"The invoice PDF is unavailable. Retry after the invoice artifact is generated.","INVOICE_REMINDER_RATE_LIMITED":"A reminder was already sent for this invoice recently. Wait five minutes, then retry.","INVOICE_SCHEDULE_INVALID":"The invoice schedule is invalid. Correct the complete schedule and replace it again.","INVOICE_SOURCE_CONFLICT":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVOICE_SOURCE_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","INVOICE_TAX_SNAPSHOT_MISSING":"The invoice has no frozen automatic tax calculation to collect against. Void the invoice and issue it again, then collect payment.","INVOICE_TAX_SNAPSHOT_STALE":"The order changed after the invoice froze its automatic tax calculation. Void the invoice and issue it again, then collect payment.","ITEMS_REQUIRED":"The item collection is empty or missing. Provide at least one item in line_items.","LAST_NAME_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","LATEST_REVISION":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","LAUNCH_TOKEN_SCOPE_MISMATCH":"The authenticated caller is not authorized for this operation. Use credentials with access to the target merchant, environment, route, and scope, then retry.","LINE_ITEM_INVALID_QUANTITY":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","LINE_ITEM_NAME_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","LINE_ITEM_NAME_TOO_LONG":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","LINE_ITEM_NEGATIVE_PRICE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","LINE_ITEM_PRICE_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","LINE_ITEM_QUANTITY_TOO_LARGE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","LINE_ITEM_REFUND_TARGET_AMBIGUOUS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","LINE_ITEM_SOURCE_CONFLICT":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","LINE_ITEM_UNIT_PRICE_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","LIST_IN_USE":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","LIST_RESERVED":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","LOCATION_CHANGED":"The Location version changed. Read the current Location and retry against its version.","LOCATION_CONFLICT":"A Location mutation conflicted with the current version or an active dependency. Use the current version or remove the reported dependency before retrying.","LOCATION_GEOGRAPHY_CHANGED":"The Location geography revision changed. Read the current Location geography and retry against its geography revision.","LOCATION_GEOGRAPHY_INVALID":"The Location geography input is structurally invalid. Correct the address, timezone, coordinate, or coordinate source and retry.","LOCATION_INVALID":"The Location request is structurally invalid. Correct the reported Location field and retry.","LOCATION_INVENTORY_CHANGED":"The Location inventory capability revision changed. Read the current inventory capability and retry against its revision.","LOCATION_IN_USE":"The Location has active dependencies. Remove or close the reported dependencies before archiving the Location.","LOCATION_NOT_ACTIVE":"The Location is not active for a new dependency or claim. Activate the Location or choose another active Location.","LOCATION_NOT_FOUND":"The Location was not found in this merchant environment. Check the Location ID and environment.","MERCHANTS_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","MERCHANT_ACCESS_REQUIRED":"The authenticated caller is not authorized for this operation. Use credentials with access to the target merchant, environment, route, and scope, then retry.","MERCHANT_ACCOUNT_NOT_READY":"The merchant payment account is not ready for domain registration. Complete merchant payment onboarding in the selected environment, then retry.","MERCHANT_ACCOUNT_SESSION_ACCOUNT_SETUP_REPAIR_REQUIRED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","MERCHANT_ACCOUNT_SESSION_ACCOUNT_SETUP_REQUIRED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","MERCHANT_ACCOUNT_SESSION_ACCOUNT_SETUP_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","MERCHANT_ACCOUNT_SESSION_CONTROLLER_MISMATCH":"The merchant is not ready for this operation. Complete the required merchant readiness or onboarding action before retrying.","MERCHANT_ACCOUNT_SESSION_INELIGIBLE":"The merchant is not ready for this operation. Complete the required merchant readiness or onboarding action before retrying.","MERCHANT_ACCOUNT_SESSION_INVALID_COMPONENT":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MERCHANT_ACCOUNT_SESSION_INVALID_LAUNCH_TOKEN":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","MERCHANT_ACCOUNT_SESSION_INVALID_POLICY_COMBINATION":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MERCHANT_ACCOUNT_SESSION_LAUNCH_TOKEN_SCOPE_MISMATCH":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","MERCHANT_ACCOUNT_SESSION_POLICY_NOT_SUPPORTED_BY_COMPONENT":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MERCHANT_ACCOUNT_SESSION_PREPARATION_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","MERCHANT_ACCOUNT_SESSION_PROVIDER_GRANT_MISMATCH":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","MERCHANT_ACCOUNT_SESSION_TARGETED_REMEDIATION_UNAVAILABLE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MERCHANT_ACCOUNT_SESSION_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","MERCHANT_ACCOUNT_SESSION_UNMAPPABLE_REQUIREMENT_ID":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MERCHANT_CHANGED":"The merchant profile version changed. Retrieve the merchant and retry with its current version as expected_version.","MERCHANT_CONTEXT_MISSING":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","MERCHANT_FINANCE_READ_FAILED":"Flint could not read the merchant billing projection. Retry with exponential backoff. Contact support with the request_id if the error persists.","MERCHANT_NOT_LOADED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","MERCHANT_ONBOARDING_REQUIRED":"The merchant is not ready for this operation. Complete the required merchant readiness or onboarding action before retrying.","MERCHANT_READINESS_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","MERCHANT_SELECTION_REQUIRED":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","METADATA_KEY_TOO_LONG":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","METADATA_TOO_LARGE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","METADATA_TOO_MANY_KEYS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","METADATA_VALUE_TOO_LONG":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","METHOD_NOT_ALLOWED":"The route exists, but does not support the requested HTTP method. Use one of the methods supported by the route, as listed in the Allow header.","ME_CUSTOMER_ID_FORBIDDEN":"The customer is determined by the customer session on every /v1/me route. Remove customer_id from the query string and request body, then retry.","MINIMUM_BALANCE_CURRENCY_MISMATCH":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MINIMUM_BALANCE_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MISSING_LINE_ITEMS":"The request must include at least one line item. Add at least one line item and retry.","MISSING_REQUIRED_FIELD":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MIXED_VARIANT_CURRENCIES":"Product variants use different currencies. Use one currency for every variant in the product.","MODIFIERS_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MODIFIERS_UNAVAILABLE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MODIFIER_CURRENCY_MISMATCH":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MODIFIER_DUPLICATE_SELECTION":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MODIFIER_GROUP_CHANGED":"The modifier group version changed. Retrieve the modifier group and retry with its current version as expected_version.","MODIFIER_GROUP_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MODIFIER_METADATA_UNSUPPORTED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MODIFIER_OVERRIDE_INVALID":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MODIFIER_QUANTITY_INVALID":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MODIFIER_SELECTION_LIMIT_EXCEEDED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MODIFIER_SOURCE_UNSUPPORTED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MODIFIER_TEXT_INVALID":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MODIFIER_UNAVAILABLE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MONEY_MOVEMENT_HISTORY_STATUS_INVALID":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","MONEY_MOVEMENT_OPERATION_BLOCKED":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","MONEY_MOVEMENT_PROVIDER_NOT_CONFIGURED":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","MONEY_MOVEMENT_PROVIDER_OPERATION_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","MONTHLY_PAYOUT_DAYS_NOT_ALLOWED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MONTHLY_PAYOUT_DAYS_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","MULTIPLE_IDENTITIES_FOUND":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","NAME_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","NORMALIZED_IMAGE_TOO_LARGE":"The normalized image exceeds Flint's canonical byte limit. Reduce the source dimensions or complexity, then retry.","NOTE_TOO_LONG":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","NOTHING_TO_REFUND_FOR_TAX_BREAKDOWN":"The selected flat tax has no refundable amount remaining. Remove the tax breakdown from the request or read the order and its refunds before retrying.","NO_DISCOUNTABLE_BALANCE":"No order balance is eligible for the requested discount. Remove the discount or add eligible line item value, then retry.","NO_FIELDS_TO_UPDATE":"The update contains no mutable fields. Provide at least one mutable field documented for this resource.","NULL_NOT_ALLOWED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","OAUTH_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","ONBOARDING_CONTROLLER_VERSION_UNSUPPORTED":"The application release cannot resume the provider-account controller policy frozen on this onboarding attempt. Restore support for the frozen controller policy version before retrying or deploying this release.","ONBOARDING_DIRECT_OWNER_REQUIRED":"The direct merchant owner who initiated onboarding no longer authorizes initial provider-account setup. Have the initiating direct owner retry, or restart before provider provisioning under the current direct owner.","ONBOARDING_PARTNER_AUTH_UNSUPPORTED":"The request could not be authenticated. Send a valid Flint credential supported by this endpoint, then retry.","ONBOARDING_PROFILE_PROVIDER_MANAGED":"The account profile is managed through the embedded account experience after provider account setup begins. Open an account-management session and edit the profile there.","ONBOARDING_SESSION_REQUIRED":"The request could not be authenticated. Send a valid Flint credential supported by this endpoint, then retry.","ONBOARDING_SESSION_TOKEN_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","ONBOARDING_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","OPTIONS_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","OPTION_REQUIRED":"A product option entry is missing. Replace the empty entry with a valid option or remove it from the array.","OPTION_VALUES_REQUIRED":"An active product option has no active values. Include at least one active value or mark the option inactive.","OPTION_VALUE_REFERENCE_REQUIRED":"A variant selection does not identify an option value. Set option_value_id, or use both client_option_key and client_value_key during product creation.","OPTION_VALUE_REQUIRED":"A product option value entry is missing. Replace the empty entry with a valid option value or remove it from the array.","OPTION_VALUE_TOO_LONG":"The product option value label is too long. Use a value label with no more than 255 characters.","ORDERS_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","ORDER_ALREADY_CLOSED":"The order is already closed. Read the order and continue from its current terminal state instead of closing it again.","ORDER_ALREADY_HAS_ACTIVE_INVOICE":"The order already has an active invoice. Use the existing invoice or close it before creating another.","ORDER_CHANGED_REFRESH_REQUIRED":"The order changed after the caller prepared its payment request. Refresh the order or checkout session and rebuild the selected payment legs from current state.","ORDER_CHARGE_ID_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","ORDER_CHARGE_NOT_FOUND":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","ORDER_CHARGE_TAX_INPUT_REQUIRED":"A taxable order charge is missing required tax input. Provide the charge tax field identified by param, then retry.","ORDER_CLOSED":"The order is closed and cannot accept this change. Read the order and continue from its current state.","ORDER_COLLECTION_ALREADY_ACTIVE":"Another collection flow is already active for this order. Finish or close the collection flow that owns the order before starting another.","ORDER_COLLECTION_IN_PROGRESS":"A checkout or invoice flow currently owns collection for the order. Finish or close the owning collection flow before starting another order payment.","ORDER_CONFLICT":"The order changed before this request could commit. Read the current order and retry the intended change.","ORDER_CUSTOMER_ALREADY_SET":"The order already belongs to a customer and cannot be reassigned. Keep the current customer_id or create a new order for a different customer.","ORDER_CUSTOMER_CHECKOUT_ACTIVE":"An open checkout already owns collection for the order, so customer authority cannot change under its issued credential. Close or expire the checkout identified by existing_checkout_session_id, set customer_id on the order, then create a new checkout.","ORDER_CUSTOMER_NOT_CLEARABLE":"The order customer cannot be cleared. Keep the current customer_id.","ORDER_CUSTOMER_NOT_UPDATABLE_AFTER_PAYMENT":"The order customer cannot change after payment begins. Set customer_id before starting payment, or keep the current customer.","ORDER_DELAYED_CAPTURE_SPLIT_PAYMENT_UNSUPPORTED":"Delayed capture currently supports only one payment leg per order attempt. Use a single manual-capture leg, or use automatic capture for split payment.","ORDER_DISCOUNT_NO_CHARGE_IDS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","ORDER_DISCOUNT_NO_LINE_ITEM_IDS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","ORDER_FINANCIAL_MUTATION_NOT_ALLOWED":"The order's financial fields cannot change after a refund is created. Use an explicit refund or credit adjustment instead of changing the order total.","ORDER_LINE_ITEM_ID_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","ORDER_LINE_ITEM_TAX_INPUT_REQUIRED":"A taxable order line item is missing required tax input. Provide the line item tax field identified by param, then retry.","ORDER_LINE_ITEM_VERSION_CONFLICT":"The line item changed after it was read. Read the current order, then retry with the line item's version as expected_version.","ORDER_NOT_FOUND":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","ORDER_OWNED_PAYMENT_INTENT_REQUIRED":"The selected payment intent is not owned by this order. Create payment intents through the order-scoped route, then select those IDs, or use payment_source for a one-shot payment.","ORDER_PAYMENT_ATTEMPT_ACTIVE":"The order has lock-owning payment work in progress. Read active_payment_attempt. Resume it only when is_resumable is true; otherwise cancel, capture, or resolve it as allowed.","ORDER_PAYMENT_FLOW_REQUIRED":"The payment intent is owned by an order and cannot be managed through a standalone payment-intent action route. Use the order payment flow to confirm, capture, or cancel this payment intent.","ORDER_PAYMENT_INTENT_CREATE_IN_PROGRESS":"Creation of an order-owned payment intent with this idempotency key is still in progress. Wait for the Retry-After delay, then retry the same request with the same idempotency key.","ORDER_PAYMENT_LEG_ALREADY_SETTLED":"The order payment leg already settled and cannot be canceled. Create a refund or reversal instead of canceling the payment.","ORDER_PERCENTAGE_TAX_FORBIDDEN":"An order-scoped tax component uses percentage calculation. Use flat_amount for an order-scoped component. Put percentage components on line items or charges.","ORDER_RECEIPT_EMAIL_UNAVAILABLE":"The order does not have an email address that can receive a receipt. Add an email address to the customer or order, then retry.","ORDER_RECEIPT_MERCHANT_MANAGED":"Flint receipt delivery is disabled because the merchant sends its own receipts. Contact the merchant to request another receipt.","ORDER_RECEIPT_NOT_AVAILABLE":"The order does not have a paid receipt that can be sent. Check that the order has a successful payment before retrying.","ORDER_RECEIPT_RESEND_RATE_LIMITED":"A receipt was already resent for this order recently. Wait five minutes, then retry.","ORDER_RECONCILIATION_REQUIRED":"The order payment state requires operational reconciliation before more money movement is safe. Do not retry blindly. Surface support and include the request_id and order ID.","ORDER_REFUNDED":"A fully refunded order cannot be closed through the normal close transition. Read the order and preserve its refunded terminal state.","ORDER_REQUIRED_FOR_TAX_BREAKDOWN_REFUND":"An order-scoped tax refund requires order_id. Provide the order_id that owns the tax breakdown.","ORDER_STATUS_NOT_CLOSABLE":"The order's current status does not allow it to be closed. Read the order and complete the actions supported by its current status before retrying.","ORDER_TAX_CALCULATION_FAILED":"Flint could not calculate tax. Retry with exponential backoff. Contact support with the request_id if the error persists.","ORDER_TAX_LOCATION_INVALID":"The provided tax location is invalid. Fix the tax.location field identified by param, then retry.","ORDER_TAX_LOCATION_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","ORDER_TAX_NOT_READY":"Automatic tax has not finished calculating for this order. Retry after the order tax status is calculated, exempt, or not_required.","ORDER_TAX_NOT_UPDATABLE_AFTER_PAYMENT":"The order tax settings cannot change after payment begins. Set tax before starting payment, or keep the current tax settings.","ORDER_TAX_RATE_UNAVAILABLE":"Flint could not produce a reproducible tax rate. Use external tax, or contact support with the request_id.","ORDER_TAX_UNSUPPORTED_COUNTRY":"Automatic tax does not support the selected country. Provide a US tax location, or use external tax.","ORDER_TIP_MODEL_UNSUPPORTED":"This order does not support requested-tip changes. Create a new order to use the current requested-tip model.","ORDER_TOTAL_BELOW_NET_COLLECTED":"The change would reduce the order total below the amount already collected. Use an explicit refund or credit adjustment instead of reducing the order total.","ORDER_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","ORG_SCOPE_RESOLUTION_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","PACKAGE_ACTION_NOT_ALLOWED":"The package cannot perform the requested action from its current state. Read current_resource.supported_actions and choose one of the listed actions.","PACKAGE_CHANGED":"The package changed after the submitted version was read. Read the current package and retry with its version as expected_version.","PACKAGE_PARENT_CHANGED":"The package's shipment or fulfillment changed while the transition was running. Retry the same package transition.","PACKAGE_REQUIRED":"The shipment has no package input. Provide shipment.package, even when it is an empty object.","PARTNER_APP_INSTALL_NOT_FOUND":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","PARTNER_APP_MANAGEMENT_REQUIRES_LIVE_KEY":"Partner app management requires a live API key. Use a live management key from Dashboard, Developers, API keys.","PARTNER_APP_NOT_FOUND":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","PARTNER_AUTH_UNSUPPORTED":"The request could not be authenticated. Send a valid Flint credential supported by this endpoint, then retry.","PARTNER_TOKEN_VALIDATION_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","PAYMENT_ACTION_EXPIRED":"The payment attempt was declined or could not be completed. Use the remediation next_actions and retry only after changing the requested payment inputs.","PAYMENT_ACTION_WINDOW_TOO_SHORT":"The hosted payment attempt does not have enough remaining time to start a redirect payment. Start a fresh order payment attempt or choose card.","PAYMENT_ATTEMPT_FROZEN":"A linked payment attempt currently prevents the requested order transition. Wait for the payment attempt to finish, then read the order before retrying.","PAYMENT_ATTEMPT_ID_REQUIRED":"An active order payment authorization must be mutated through its owning payment attempt. Send the payment_attempt_id returned by PayOrder or active_payment_attempt.","PAYMENT_ATTEMPT_IN_PROGRESS":"A payment attempt owns the resource. Finish or cancel the owning payment attempt before changing the resource.","PAYMENT_ATTEMPT_MISMATCH":"The submitted payment attempt does not own the selected payment intent. Refresh the order or payment attempt, then send the owning payment_attempt_id.","PAYMENT_ATTEMPT_NOT_RESUMABLE":"The requested payment attempt cannot be resumed from its current status. Read the attempt status and start, cancel, or capture only the work allowed by that state.","PAYMENT_ATTEMPT_RESUME_CONFLICT":"A payment-attempt resume request included fields that belong to a new start. Send payment_attempt_id alone, with only an optional expected_outstanding_money assertion.","PAYMENT_ATTEMPT_STILL_PROCESSING":"A previous payment attempt is still processing. Wait briefly, then read the order and retry only after the attempt leaves processing.","PAYMENT_BLOCKED":"The payment attempt was declined or could not be completed. Use the remediation next_actions and retry only after changing the requested payment inputs.","PAYMENT_CAPTURE_METHOD_NOT_ALLOWED":"The requested capture method is not allowed for this order payment caller or start shape. Use automatic capture, or create an explicit merchant-authorized payment leg for delayed capture.","PAYMENT_CONFIRMATION_STATE_CHANGED":"The confirmation request no longer matches the PaymentIntent's durable attempt or checkout binding. Refresh the PaymentIntent and its owning checkout, then start a new confirmation only if the current state permits it.","PAYMENT_FAILED":"The payment attempt was declined or could not be completed. Use the remediation next_actions and retry only after changing the requested payment inputs.","PAYMENT_INTENT_AMOUNT_INVALID":"The PaymentIntent does not contain a positive collectible amount and currency. Create or update the PaymentIntent with a positive amount before starting hosted collection.","PAYMENT_INTENT_CAPTURE_METHOD_UNSUPPORTED":"Direct hosted PaymentIntent collection does not support delayed capture. Create the PaymentIntent with automatic capture before starting checkout.","PAYMENT_INTENT_CHECKOUT_ALREADY_EXISTS":"An open hosted checkout already owns collection for this PaymentIntent. Reuse the checkout identified by existing_checkout_session_id.","PAYMENT_INTENT_CHECKOUT_CHANGED":"The PaymentIntent can no longer be bound to the requested checkout session. Read the PaymentIntent and its current checkout session before creating another hosted collection flow.","PAYMENT_INTENT_CHECKOUT_COMMERCE_CONFIG_UNSUPPORTED":"A direct PaymentIntent checkout cannot change its fixed balance with checkout commerce features. Omit tips, tax, promotions, and fulfillment from the checkout request.","PAYMENT_INTENT_CHECKOUT_SOURCE_CONFLICT":"A direct PaymentIntent checkout was combined with another checkout owner or replacement operation. Send payment_intent_id as the only collection source, without invoice_id, payment_link_id, or replace_checkout_session_id.","PAYMENT_INTENT_HAS_ORDER":"The PaymentIntent is already owned by an Order. Create hosted checkout with order_id so the Order remains the collection authority.","PAYMENT_INTENT_NOT_COLLECTIBLE":"The PaymentIntent cannot accept hosted collection in its current state. Read the PaymentIntent and start checkout only while it still permits buyer payment.","PAYMENT_INTENT_NOT_FOUND":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","PAYMENT_INTENT_OPTIONS_IMMUTABLE":"Checkout cannot override the payment options frozen on a direct PaymentIntent. Omit payments from the checkout request. Configure payment_options on the PaymentIntent.","PAYMENT_INTENT_OPTIONS_REQUIRED":"The PaymentIntent has no payment option available for hosted collection. Configure at least one supported payment option on the PaymentIntent before starting checkout.","PAYMENT_INTENT_OPTIONS_UNSUPPORTED":"The PaymentIntent contains a payment option not supported by direct hosted collection. Use card, Apple Pay, or Google Pay, or collect the PaymentIntent through a supported non-hosted integration.","PAYMENT_LEG_SELECTION_REQUIRED":"The order payment request needs an explicit payment-leg selection. Select the payment intents listed in the error details, create an order-owned leg, or use payment_source when no selectable leg exists.","PAYMENT_LINKS_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","PAYMENT_LINK_CHANGED":"The payment link version changed. Read the current payment link and retry with its version as expected_version.","PAYMENT_LINK_CHANGED_RETRY":"The payment link changed before the checkout publication committed. Read the public payment link again and start a new resolve operation with a new context and idempotency key.","PAYMENT_LINK_FULFILLMENT_UNAVAILABLE":"The payment link references delivery configuration that is not currently available. Update the payment link to use active delivery methods, then resolve it again.","PAYMENT_LINK_NOT_FOUND":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","PAYMENT_LINK_RESOLUTION_CONTEXT_INVALID":"The payment-link resolution context is invalid or expired. Read the public payment link again and start a new resolve operation with the newly issued context.","PAYMENT_LINK_RESOLUTION_CONTEXT_REFRESH_REQUIRED":"The signed context no longer has enough lifetime to start a new checkout publication safely. Read the public payment link again and start a new resolve operation with the refreshed context.","PAYMENT_LINK_RESOLUTION_CONTEXT_REQUIRED":"Payment-link resolution requires a server-issued resolution context. Read the public payment link, then send its resolution_context with the resolve request.","PAYMENT_LINK_RESOLUTION_RATE_LIMITED":"The client exceeded the per-link limit for public payment-link work. Wait briefly, then retry. Reuse the same context and idempotency key unless the context expired.","PAYMENT_LINK_RESOLUTION_REPLAY_UNAVAILABLE":"The checkout recorded for this payment-link operation can no longer issue authentication. Read the public payment link again and start a new checkout operation.","PAYMENT_LINK_RESOLUTION_UNAVAILABLE":"Flint could not issue or recover a payment-link resolution context. Read the public payment link again. Contact support with the request_id if the error persists.","PAYMENT_METHOD_CUSTOMER_MISMATCH":"The payment method belongs to a different customer. Use an active payment method owned by the subscription customer.","PAYMENT_METHOD_DECLINED":"The payment attempt was declined or could not be completed. Use the remediation next_actions and retry only after changing the requested payment inputs.","PAYMENT_METHOD_DOMAINS_UNAVAILABLE":"Payment method domain records are temporarily unavailable. Retry with exponential backoff. Contact support with the request_id if the error persists.","PAYMENT_METHOD_DOMAIN_ALREADY_EXISTS":"The exact domain is already registered in this merchant environment. Use the payment_method_domain_id returned in error.details.","PAYMENT_METHOD_DOMAIN_NOT_FOUND":"The payment method domain was not found in this merchant environment. Check the payment_method_domain_id and selected environment.","PAYMENT_METHOD_DOMAIN_OPERATION_IN_PROGRESS":"Another payment method domain operation is still in progress. Wait for the active operation to finish, then retry with the same Idempotency-Key.","PAYMENT_METHOD_DOMAIN_REGISTRATION_FAILED":"The external wallet domain registration could not be updated. Retry the same logical request with the same Idempotency-Key. Contact support with the request_id if the error persists.","PAYMENT_METHOD_NOT_ACTIVE":"The saved payment method is not active. Use an active saved payment method, then retry.","PAYMENT_METHOD_NOT_READY":"The payment method setup has not finished. Wait for payment_method.saved or poll until the payment method is active, then retry.","PAYMENT_METHOD_REQUIRED":"A required saved payment method was not provided or could not be resolved. Provide or collect an active saved payment method, then retry.","PAYMENT_METHOD_TEMPORARILY_UNAVAILABLE":"The payment attempt was declined or could not be completed. Use the remediation next_actions and retry only after changing the requested payment inputs.","PAYMENT_METHOD_UNAVAILABLE":"The payment attempt was declined or could not be completed. Use the remediation next_actions and retry only after changing the requested payment inputs.","PAYMENT_NOT_COMPLETED":"The payment attempt was declined or could not be completed. Use the remediation next_actions and retry only after changing the requested payment inputs.","PAYMENT_NOT_REQUIRED":"The collection context has no outstanding balance to charge. Complete the zero-balance order without a payment source, or use setup_payment_source for an allowed future-billing setup.","PAYMENT_OPERATION_IN_PROGRESS":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","PAYMENT_OPTIONS_REQUIRED":"A standalone PaymentIntent requires an explicit non-empty payment_options list. Provide at least one supported Flint payment option and retry.","PAYMENT_OPTION_LIMIT_EXCEEDED":"The invoice balance exceeds the configured limit for this payment option. Use an allowed payment option with a sufficient limit.","PAYMENT_OPTION_NOT_ALLOWED":"The saved payment method is not allowed by this invoice. Use the frozen saved card for automatic collection.","PAYMENT_OPTION_NOT_READY":"The payment option has one or more readiness blockers. Use the error details to identify every blocker, its reason, and the responsible next step.","PAYMENT_OPTION_RESOLVE_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","PAYMENT_PROCESSING_UNAVAILABLE":"Payment processing is temporarily unavailable for this merchant environment. Retry with exponential backoff. Contact support with the request_id if processing remains unavailable.","PAYMENT_RETURN_URL_INVALID":"The payment return destination violates Flint's clean redirect rules. Use an absolute HTTPS URL without credentials, a query, or a fragment. Test-mode loopback URLs may use HTTP.","PAYMENT_RETURN_URL_REQUIRED":"A redirect-capable payment option requires a clean browser return destination. Set payment_return_url to an absolute HTTPS URL without credentials, a query, or a fragment.","PAYMENT_SOURCE_CONFLICT":"The request supplied mutually exclusive payment credentials. Keep exactly one credential field from conflicting_fields and retry.","PAYMENT_SOURCE_NOT_ALLOWED":"The submitted payment source is not allowed for this caller or payment mode. Use a payment source allowed for the authenticated caller and retry.","PAYMENT_SOURCE_OWNERSHIP_MISMATCH":"The saved payment method is not owned by the customer authorized for this order payment. Use a saved payment method owned by the checkout customer, or collect a new payment source.","PAYMENT_SOURCE_REQUIRED":"The payment start request does not include a payment source. Submit payment_intents with credentials, payment_source, setup_payment_source, or a resumable payment_attempt_id.","PAYMENT_SOURCE_SELECTION_CONFLICT":"The request supplied both a legacy payment source selection and payment options. Remove payment_source_selection and use payment_options for the order payment.","PAYMENT_SOURCE_SELECTION_REQUIRED":"The payment source selection did not choose a supported source. Select the card branch in payment_source_selection and retry.","PAYMENT_SOURCE_UNAVAILABLE":"The submitted payment source is no longer available for this attempt. Collect or select another payment source and start a new attempt.","PAYMENT_START_SHAPE_CONFLICT":"The request mixed mutually exclusive order payment start shapes. Keep exactly one of payment_source, payment_intents, or setup_payment_source and retry.","PAYOUT_DELAY_PROVIDER_CONTROLLED":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","PAYOUT_DESTINATION_NOT_FOUND":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","PAYOUT_DESTINATION_UPDATE_EMPTY":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","PAYOUT_ENTRIES_UNAVAILABLE":"Authoritative payout allocation evidence is temporarily unavailable. Retry after the Retry-After delay. Contact support with the request_id if the error persists.","PAYOUT_FEE_NOT_DETERMINABLE":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","PAYOUT_NOT_CANCELABLE":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","PAYOUT_NOT_FOUND":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","PAYOUT_SETTINGS_MANAGED_EXTERNALLY":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","PAYOUT_SETTINGS_SNAPSHOT_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","PAYOUT_SETTINGS_UPDATE_EMPTY":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","PAYOUT_STATUS_NOT_CANCELABLE":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","PLAN_NOT_ACTIVE":"The subscription plan is not active. Use an active subscription plan.","POLICY_NOT_SUPPORTED_BY_COMPONENT":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","PROCESSING_ERROR":"The payment attempt was declined or could not be completed. Use the remediation next_actions and retry only after changing the requested payment inputs.","PROCESSING_FEE_PRICING_NOT_AUTHORIZED":"No authorized processing price covers this payment, so it was rejected before reaching the processor. Contact the merchant account owner to confirm that this payment option and amount are enabled. Retrying the same request will not succeed until the account configuration changes.","PROCESSING_FEE_PRICING_UNAVAILABLE":"Flint could not resolve the processing price for this payment. No payment was submitted to the processor. Retry the same logical request with the same idempotency key. Contact support with the request_id if it persists.","PRODUCT_LINE_ITEM_SOURCE_UNSUPPORTED":"The line item identifies a product without a sellable variant or bundle. Provide variant_id, bundle_id, or ad-hoc line item fields instead of product_id alone.","PROFILE_RECONCILIATION_PENDING":"The account accepted the profile update, but Flint has not finished reconciling the profile. Retry with the same idempotency key.","PROFILE_UPDATE_STATUS_UNKNOWN":"Flint could not confirm the account profile update. Retry with the same idempotency key.","PROFILE_WRITE_LIVE_MODE_REQUIRED":"Provider-backed merchant profile fields cannot be changed with a sandbox credential. Use a live-mode credential to update support or website profile fields.","PROMOTION_CONFLICT":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","PROMOTION_DECLINED":"The promotion could not be applied to this order. Use reason to correct the promotion or order inputs, then retry.","PROMOTION_FILTER_TARGET_CONFLICT":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","PROMOTION_ID_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","PROMOTION_NOT_REDEEMABLE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","PROMOTION_NO_ACTIVE_CODES":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","PROVIDER_ACCOUNT_CLEANUP_REQUIRED":"The merchant is not ready for this operation. Complete the required merchant readiness or onboarding action before retrying.","PROVIDER_READINESS_UNAVAILABLE":"Flint could not evaluate payment option provider readiness. Retry with exponential backoff. Contact support with the request_id if the error persists.","PROVISIONING_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","RANGE_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","RATE_LIMIT_EXCEEDED":"The request exceeded the configured rate limit. Retry with exponential backoff and jitter. Use the Retry-After header when present.","READ_ONLY_REASON":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","RECIPIENT_EMAIL_REQUIRED":"Invoice email delivery requires a recipient email. Set recipient_email or issue with caller_managed delivery.","REFUND_ADJUSTMENT_AMOUNT_MONEY_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","REFUND_ADJUSTMENT_REASON_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","REFUND_ADJUSTMENT_REFUND_AMOUNT_MONEY_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","REFUND_INSUFFICIENT_AVAILABLE_BALANCE":"The connected account does not have enough available balance to issue the refund. Restore the connected account's available balance, then retry with the same idempotency key.","REFUND_LINE_ITEM_ADJUSTMENT_ID_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","REFUND_SUBMISSION_DEADLINE_EXPIRED":"The payment method's provider refund-submission window has ended. Reimburse the customer outside the original payment method and preserve the Refund history for reconciliation.","RELATED_OBJECT_ID_UNSUPPORTED_FOR_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","RELATED_OBJECT_TYPE_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","REPORTING_UNAVAILABLE":"Reporting is temporarily unavailable. Retry the request. Contact support with the request_id if the error persists.","REPORT_DOWNLOAD_EXPIRED":"The report download expired. Create a new report for the same interval.","REPORT_INTERVAL_INCOMPLETE":"The report interval has not finished yet. Use an interval_end_at at or before the current time.","REPORT_INTERVAL_TOO_LARGE":"The report interval exceeds the limit for its report type. Request a shorter interval.","REPORT_NOT_FOUND":"The report or download was not found. Check the Flint report ID and the API key environment.","REQUEST_BODY_NOT_ALLOWED":"This operation does not accept request fields. Send an empty request body or {}.","REQUEST_FAILED":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","REQUEST_TIMEOUT":"The request timed out before Flint could complete it. Retry with exponential backoff. Contact support with the request_id if the timeout persists.","RESERVED_FIELD_NOT_YET_SUPPORTED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","RESERVED_METADATA_KEY":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","RESOURCE_LIMIT_EXCEEDED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","RESOURCE_NOT_FOUND":"The requested resource could not be found for the authenticated merchant and environment. Check the resource ID, mode, and merchant context, then retry.","RESOURCE_TIMELINE_TOKEN_INVALID":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","RETURN_ACTION_NOT_ALLOWED":"The requested Return action is not available in the current lifecycle state. Read the resource's supported_actions and current blockers before choosing the next action.","RETURN_COMPLETION_BLOCKED":"The Return still has completion blockers. Read completion_blockers, resolve each outstanding fact or effect, and retry.","RETURN_DECISION_SCOPE_REQUIRED":"The composite Return request includes a policy override that the current credential cannot authorize. Use policy-backed decision values, or use a credential that also has commerce.returns.decisions.write.","RETURN_DISPOSITION_QUANTITY_EXCEEDED":"The disposition exceeds available receipt or finalized inspection capacity. Read the current receipt or inspection line capacity and submit an available quantity.","RETURN_FULFILLMENT_ALLOCATION_AMBIGUOUS":"The Order line belongs to multiple completed Fulfillments. Choose one of the candidate fulfillment_id values returned by the error.","RETURN_INSPECTION_QUANTITY_EXCEEDED":"The inspection exceeds current receipt-line capacity. Read the current receipt line and inspect only its available quantity.","RETURN_INVALID":"The Return request is structurally or semantically invalid. Correct the fields identified by the error and retry.","RETURN_LINE_CANCELLATION_CONFLICT":"The requested Return line quantity is no longer safely cancelable. Use available_quantity and blocking_resources to cancel a smaller quantity or resolve the blocking work first.","RETURN_NOT_FOUND":"The Return resource was not found in this merchant environment. Check the resource ID and environment.","RETURN_PAYMENT_INTENT_MISMATCH":"The PaymentIntent is not owned by the requested Return resolution. Launch collection through the Return resolution that created the PaymentIntent.","RETURN_POLICY_CONFLICT":"More than one Return policy matched with the same precedence. Change policy priority or scope so the evaluation has one deterministic winner.","RETURN_RECEIPT_QUANTITY_EXCEEDED":"The receipt verification exceeds outstanding handback capacity. Read the Return line quantities and verify only the available quantity.","RETURN_VALUE_EXCEEDED":"The proposed resolution exceeds available Return quantity or value. Preview or read the current Return and allocate only unreserved value.","RETURN_VERSION_CONFLICT":"The Return resource changed before the mutation committed. Read the current version, reconcile the change, and retry with the current expected version.","REVIEW_ALREADY_CLOSED":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","REVIEW_NOT_FOUND":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","REVIEW_RESOLUTION_IN_PROGRESS":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","RISK_CONTROL_CONFLICT":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","RISK_EVALUATION_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","RISK_LIST_ALIAS_ALREADY_EXISTS":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","RISK_RESOURCE_NOT_FOUND":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","ROUTE_NOT_FOUND":"No public API route matched the request path. Check the path and remove unsupported trailing slashes or legacy routes before retrying.","RULE_LIMIT_EXCEEDED":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","RULE_RESERVED":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","SANDBOXES_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","SANDBOX_ALREADY_EXISTS":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","SANDBOX_ARCHIVED":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","SANDBOX_ARCHIVE_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","SANDBOX_BOOTSTRAP_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","SANDBOX_CREATE_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","SANDBOX_ID_NOT_ALLOWED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","SANDBOX_ID_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","SANDBOX_INACTIVE":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","SANDBOX_LIST_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","SANDBOX_LOOKUP_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","SANDBOX_MANAGEMENT_REQUIRES_LIVE_KEY":"Sandbox management requires a live API key. Use a live management key from Dashboard, Developers, API keys.","SANDBOX_NOT_ACCESSIBLE":"The authenticated caller is not authorized for this operation. Use credentials with access to the target merchant, environment, route, and scope, then retry.","SANDBOX_NOT_FOUND":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","SANDBOX_PLANE_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","SANDBOX_RESET_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","SANDBOX_RESET_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","SANDBOX_SELECTION_FORBIDDEN":"The authenticated caller is not authorized for this operation. Use credentials with access to the target merchant, environment, route, and scope, then retry.","SANDBOX_SELECTION_REQUIRED":"The test-mode API key is not bound to a sandbox. Create or use a sandbox-bound test key for the sandbox this request should target, then retry.","SCOPES_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","SCOPE_NOT_ALLOWED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","SCOPE_NOT_ALLOWED_FOR_KEY_MODE":"The requested scope is not available for the target API key mode. Remove the scope or create or use a live key from Dashboard, Developers, API keys.","SENSITIVE_IDEMPOTENCY_ENCRYPTION_INVALID":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","SENSITIVE_IDEMPOTENCY_ENCRYPTION_UNCONFIGURED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","SENSITIVE_IDEMPOTENCY_RESULT_INVALID":"A secret-bearing mutation did not provide the recovery metadata required for safe durable replay. Do not retry blindly. Contact Flint support with the request_id.","SERVER_GENERATED_ID":"The request supplied an ID that Flint assigns during creation. Remove the server-generated ID from the create request.","SERVICE_CHARGE_DISCOUNT_NO_LINE_ITEM_IDS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","SERVICE_CHARGE_DISCOUNT_REQUIRES_CHARGE_IDS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","SERVICE_CHARGE_DISCOUNT_SCOPE_INVALID":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","SERVICE_UNAVAILABLE":"A service required to complete the request is temporarily unavailable. Retry with exponential backoff. Contact support with the request_id if the error persists.","SETTINGS_CONCURRENT_MODIFICATION":"The catalog default changed after it was read. Read settings, reapply the intended change, and retry.","SETTINGS_UNAVAILABLE":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","SHIPMENT_CHANGED":"The shipment changed after the submitted version was read. Read the current shipment and retry with its version as expected_version.","SOURCE_CONTEXT_CONFLICT":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","STANDARD_PAYOUT_REQUIRES_MANUAL_SCHEDULE":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","STREAMING_UNAVAILABLE":"The server cannot establish a streaming response. Retry with exponential backoff. Contact support with the request_id if the error persists.","SUBSCRIPTION_BILLING_SCHEDULE_REQUIRED":"The billing anchor requires an explicit Flint-owned schedule. Set billing_schedule.owner to flint or remove billing_anchor_day.","SUBSCRIPTION_BILLING_START_INVALID":"The subscription billing start branch is missing, mixed, or invalid. Send exactly one immediate, scheduled, or imported billing_start branch.","SUBSCRIPTION_CANCELED":"The canceled subscription cannot be changed. Create a new subscription for a new agreement.","SUBSCRIPTION_EXTERNAL_BILLING_ANCHOR_NOT_ALLOWED":"External billing schedules do not use a billing anchor day. Remove billing_anchor_day or select billing_schedule.owner flint.","SUBSCRIPTION_IMPORT_PERIOD_NOT_CURRENT":"The imported paid period does not cover the current time. Provide the start of a paid period whose computed end is still in the future.","SUBSCRIPTION_INITIATED_BY_INVALID":"The schedule mutation does not identify a supported initiator. Set initiated_by to buyer, merchant, or integration.","SUBSCRIPTION_NEXT_BILLING_AT_BEFORE_PERIOD_START":"The requested next billing time is before the current subscription period starts. Set next_billing_at to current_period_start or a later time.","SUBSCRIPTION_NEXT_BILLING_AT_NOT_FUTURE":"The requested next billing time is not in the future. Provide the earliest acceptable future next_billing_at value.","SUBSCRIPTION_NEXT_BILLING_AT_REQUIRED":"A Flint-owned schedule requires its next billing time. Provide a future next_billing_at value.","SUBSCRIPTION_NEXT_BILLING_AT_TOO_FAR":"The Flint-owned billing date moves more than one plan interval forward. Choose a date within one plan interval or pause the subscription.","SUBSCRIPTION_NOT_FOUND":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","SUBSCRIPTION_PAYMENT_RETRY_NOT_ALLOWED":"A manual payment retry is only available for a past-due subscription. Fetch the subscription and create a retry only while its status is past_due.","SUBSCRIPTION_PLAN_NOT_FOUND":"The request could not be completed as submitted or in its current state. Inspect the error response, correct the request or resource state, then retry.","SUBSCRIPTION_SCHEDULE_CLEAR_NOT_ALLOWED":"A Flint-owned schedule cannot clear its next billing date. Provide next_billing_at or transfer the schedule to external ownership.","SUBSCRIPTION_SCHEDULE_MUTATION_NOT_ALLOWED":"The subscription lifecycle state blocks the schedule mutation. Read the current status in error details and wait for recovery or choose a lifecycle action that applies.","SUBSCRIPTION_SERVICE_LOCATION_INVALID":"The subscription service location is missing, mixed, or belongs to another customer. Send one valid service_location source owned by the subscription customer.","SUBSCRIPTION_STARTS_AT_NOT_FUTURE":"The scheduled subscription start is not in the future. Set billing_start.starts_at to a future RFC3339 timestamp.","SUBSCRIPTION_STARTS_AT_TRIAL_CONFLICT":"A scheduled start cannot be combined with a plan trial. Use an immediate start for the trial or use a plan without a trial.","SUBSCRIPTION_START_OVERRIDE_NOT_ALLOWED":"A paid checkout cannot use a scheduled or imported subscription start. Use the immediate billing_start branch for a checkout that already collected payment.","TARGETED_REMEDIATION_UNAVAILABLE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","TAX_BREAKDOWN_ID_REQUIRED":"A tax breakdown refund is missing tax_breakdown_id. Provide the tax_breakdown_id from the original order tax breakdown.","TAX_BREAKDOWN_NOT_ORDER_SCOPED_FLAT":"The selected tax breakdown is not an order-scoped additive flat tax. Use a flat tax_breakdown_id from the original order, or refund percentage tax through its line allocation.","TAX_BREAKDOWN_REFUND_MONEY_REQUIRED":"A tax breakdown refund is missing tax_money. Provide tax_money for each tax breakdown being reversed.","TAX_BREAKDOWN_TARGETS_EXCEED_REFUND_AMOUNT":"Tax breakdown refund targets exceed the requested refund amount. Increase amount_money or remove tax breakdown targets.","TAX_CALCULATION_REQUIRED":"External tax is missing a calculation for a taxable line item or charge. Provide tax.calculation for every taxable line item and charge.","TAX_INPUT_CONFLICT":"The tax input disables tax and also supplies a calculation or location. Set tax.enabled to true, or omit tax.calculation and tax.location.","TAX_MODE_MISMATCH":"A nested tax calculation uses a different mode from the order tax calculation. Use the same mode for the order, line item, and charge tax calculations.","TIP_ALLOCATION_CAPACITY_EXCEEDED":"The selected payment legs cannot carry the requested tip. Select enough tip-capable payment capacity or reduce the requested tip, then retry.","TIP_CURRENCY_MISMATCH":"The requested tip currency differs from the order currency. Use the order currency for the requested tip amount.","TIP_LIMIT_EXCEEDED":"The requested tip is above the maximum allowed for the order. Use a requested tip no greater than maximum_money, then retry.","TOO_MANY_LINE_ITEMS":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","TOO_MANY_PENDING_REPORTS":"Five reports are already pending for this merchant environment. Wait for a pending report to finish before creating another.","TRANSACTION_PURPOSE_NOT_APPLICABLE":"The request supplied an ACH-only field without requesting ACH Direct Debit. Remove transaction_purpose or include ach_debit in payment_options.","TRANSACTION_PURPOSE_REQUIRED":"ACH Direct Debit requires a transaction purpose. Set transaction_purpose to goods, services, or other and retry.","UNKNOWN_BUNDLE_COMPONENT":"The bundle component ID does not belong to this bundle. Use a bundle_component_id returned for this bundle, or omit it to create a new component.","UNKNOWN_CLIENT_OPTION_VALUE":"A variant selection references an unknown client option or value key. Use client keys declared in the same product create request.","UNKNOWN_FIELD":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry with the same idempotency key if this was the same logical operation.","UNKNOWN_OPTION":"The option ID does not belong to this product. Use an option_id returned for this product, or omit it to create a new option.","UNKNOWN_OPTION_VALUE":"The option value ID does not belong to this option. Use an option_value_id returned for this option, or omit it to create a new value.","UNKNOWN_SCOPE":"The request includes a scope that is not in Flint's public scope catalog. Use a canonical scope from the API key scope catalog and retry.","UNMAPPABLE_REQUIREMENT_ID":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","UNSAFE_FEEDBACK_CONTENT":"The feedback contains unsafe control characters, credentials, or secret material. Remove secrets and unsafe characters, then submit only the evidence needed to describe the behavior.","UNSUPPORTED_APPLICATION_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","UNSUPPORTED_CONTENT_TYPE":"The request body used an unsupported Content-Type. Send JSON request bodies with Content-Type: application/json, then retry.","UNSUPPORTED_CURRENCY":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","UNSUPPORTED_PRODUCT_FIELD":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","UNSUPPORTED_QUERY_PARAM":"The request included a query parameter this endpoint does not support. Remove the unsupported query parameter or use a documented accepted expand encoding.","UNSUPPORTED_RESOURCE_TYPE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","UPDATE_MASK_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","USE_CANCEL_SUBSCRIPTION":"Cancellation must use the subscription cancel action. Call the subscription cancel endpoint instead of updating lifecycle fields.","VALIDATION_ERROR":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry with the same idempotency key if this was the same logical operation.","VALUE_REQUIRED":"A product option value label is missing. Provide a non-empty value label.","VARIANTS_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","VARIANT_IN_ACTIVE_BUNDLE":"The variant is used by an active bundle. Set every referencing bundle to inactive before changing or retiring the variant or its selected option labels.","VARIANT_NOT_SELLABLE":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","VARIANT_OPTION_COMBINATION_ALREADY_EXISTS":"Two variants select the same option-value combination. Give each variant a unique combination of selected option values.","VERIFICATION_ALREADY_USED":"The request could not be authenticated. Send a valid Flint credential supported by this endpoint, then retry.","VERIFICATION_CODE_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","VERIFICATION_EMAIL_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","VERIFICATION_TOKEN_FAILED":"Flint could not complete the request because a required service or internal operation failed. Retry with exponential backoff. Contact support with the request_id if the error persists.","WEBHOOKS_UNAVAILABLE":"Webhook event records are temporarily unavailable. Retry with exponential backoff. Contact support with the request_id if the error persists.","WEBHOOK_DELIVERY_IN_FLIGHT":"The webhook delivery is already being processed. Wait for the active delivery attempt to finish, then retry the resend if needed.","WEBHOOK_DELIVERY_UNAVAILABLE":"Webhook delivery is temporarily unavailable. Retry with exponential backoff. Contact support with the request_id if the error persists.","WEBHOOK_ENDPOINT_NOT_ACTIVE":"The webhook endpoint is not active. Enable the endpoint and resolve any endpoint configuration issue before resending.","WEBHOOK_EVENT_PAYLOAD_EXPIRED":"The retained webhook event payload has expired. Use a newer webhook event. Expired payloads cannot be resent.","WEBHOOK_STREAM_CONNECTION_LIMIT":"The environment has too many active webhook event streams. Close an existing stream or wait for one to expire, then reconnect.","WEBHOOK_STREAM_LIMITER_UNAVAILABLE":"Webhook stream coordination is temporarily unavailable. Retry with exponential backoff.","WEBHOOK_STREAM_NOTIFIER_UNAVAILABLE":"Webhook stream notifications are temporarily unavailable. Retry with exponential backoff.","WEEKLY_PAYOUT_DAYS_NOT_ALLOWED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry.","WEEKLY_PAYOUT_DAYS_REQUIRED":"The request payload or query parameters did not pass validation. Fix the field identified by the error response, then retry."}},"conflict_details":{"items":{"$ref":"#/components/schemas/CheckoutSessionRevisionConflictDetail"},"type":"array"},"conflicting_fields":{"items":{"type":"string"},"type":"array"},"current_checkout_session_id":{"type":"string"},"current_money":{"$ref":"#/components/schemas/Money","description":"Current money amount counted toward the threshold, when the error is threshold-based."},"current_resource":{"description":"Current fulfillment, shipment, or package returned when a conditional write conflicts with resource state.","oneOf":[{"$ref":"#/components/schemas/Fulfillment"},{"$ref":"#/components/schemas/Shipment"},{"$ref":"#/components/schemas/Package"}]},"current_selection_id":{"description":"Current effective delivery selection ID returned with a selection concurrency conflict.","type":"string"},"current_status":{"description":"Current lifecycle status of the resource when the requested mutation is not allowed.","type":"string"},"current_version":{"format":"uint64","minimum":0,"type":"integer"},"details":{"items":{"$ref":"#/components/schemas/ErrorDetail"},"type":"array"},"doc_url":{"description":"Developer error-handling documentation.","type":"string"},"error_source":{"description":"System boundary responsible for correcting the failure.","enum":["merchant","integration","flint"],"type":"string","x-enum-descriptions":["Merchant.","Integration.","Flint."],"x-flint-enum":"closed"},"existing_checkout_session_id":{"type":"string"},"expected_attempt_outstanding_money":{"$ref":"#/components/schemas/Money"},"gap_money":{"$ref":"#/components/schemas/Money","description":"Additional money amount needed to satisfy the threshold, when the error is threshold-based."},"is_resumable":{"type":"boolean"},"limit":{"format":"int64","type":"integer"},"maximum_money":{"$ref":"#/components/schemas/Money","description":"Maximum money amount accepted by the failed validation, calculated from the current resource state."},"message":{"type":"string"},"missing_scopes":{"description":"Unsatisfied entries from scope_requirement after write-implies-read evaluation.","example":["accounts.api_keys.write"],"items":{"type":"string"},"type":"array"},"param":{"type":"string"},"payment_attempt_id":{"type":"string"},"payment_attempt_status":{"description":"Current Flint order payment attempt status associated with this error.","enum":["open","requires_action","processing","requires_capture","requires_retry","finalizing","partially_succeeded","succeeded","failed","canceled","expired"],"type":"string","x-enum-descriptions":["Open.","Requires action.","Processing.","Requires capture.","Requires retry.","Finalizing.","Partially succeeded.","Succeeded.","Failed.","Canceled.","Expired."],"x-flint-enum":"open"},"payment_intent_ids":{"items":{"type":"string"},"type":"array"},"payment_option":{"description":"Flint payment option associated with this error, when the error is about a specific requested or selected payment option.","enum":["card","apple_pay","google_pay","affirm","ach_debit"],"type":"string","x-enum-descriptions":["Card.","Apple pay.","Google pay.","Affirm.","Ach debit."],"x-flint-enum":"closed"},"quota":{"$ref":"#/components/schemas/QuotaDetails","description":"Structured resource quota state when the error is caused by quota exhaustion."},"reason":{"description":"Stable Flint reason code associated with this error. For payment option availability errors this matches PaymentOptionBlocker.code. When code is PROMOTION_DECLINED, branch on reason. Promotion decline reasons are: not_eligible, minimum_not_met, expired, not_yet_started, exhausted, code_required, code_invalid, disabled, automatic_disabled, codes_disabled, already_applied, not_combinable, superseded_by_better_offer, superseded, max_promotions_reached, no_discountable_balance, buy_item_missing, currency_mismatch, unknown_type.","type":"string"},"remediation":{"$ref":"#/components/schemas/ErrorRemediation"},"request_id":{"type":"string"},"request_log_url":{"description":"Authenticated request-log lookup filtered to this request_id.","type":"string"},"required_money":{"$ref":"#/components/schemas/Money","description":"Money amount required to satisfy a minimum threshold, when the error is threshold-based."},"scope_requirement":{"$ref":"#/components/schemas/ScopeRequirement","description":"Complete route or delegation scope requirement for an INSUFFICIENT_SCOPE error."},"selectable_payment_intents":{"items":{"$ref":"#/components/schemas/SelectableOrderPaymentIntent"},"type":"array"},"submitted_money":{"$ref":"#/components/schemas/Money"},"supported_actions":{"description":"Actions currently accepted by the resource.","items":{"type":"string"},"type":"array"},"tip_capable_money":{"$ref":"#/components/schemas/Money"},"type":{"enum":["authentication_error","authorization_error","validation_error","not_found_error","conflict_error","rate_limit_error","payment_error","external_service_error","timeout_error","unavailable_error","internal_error","invalid_request_error"],"type":"string","x-enum-descriptions":["Authentication error.","Authorization error.","Validation error.","Not found error.","Conflict error.","Rate limit error.","Payment error.","External service error.","Timeout error.","Unavailable error.","Internal error.","Invalid request error."],"x-flint-enum":"closed"}},"required":["code","doc_url","error_source","message","type"],"type":"object"},"ErrorRemediation":{"properties":{"missing_or_invalid_fields":{"items":{"type":"string"},"type":"array"},"next_actions":{"items":{"$ref":"#/components/schemas/NextAction"},"type":"array"},"next_steps":{"type":"string"},"retryable":{"type":"boolean"}},"type":"object"},"ErrorResourceReference":{"properties":{"resource_id":{"description":"Public Flint ID of the blocking resource.","type":"string"},"resource_type":{"description":"Stable public resource name for the blocking resource.","type":"string"},"status":{"description":"Current public status of the blocking resource when available.","type":"string"}},"required":["resource_id","resource_type"],"type":"object"},"ExpandedCustomerSummary":{"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"customer_id":{"type":"string"},"email":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["customer_id","email"],"type":"object"},"ExpandedInvoiceSummary":{"properties":{"collection_block_status":{"enum":["none","inventory_blocked","resolved"],"type":"string","x-enum-descriptions":["None.","Inventory blocked.","Resolved."],"x-flint-enum":"open"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"customer_id":{"type":"string"},"due_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"is_overdue":{"type":"boolean"},"order_id":{"type":"string"},"outstanding_money":{"$ref":"#/components/schemas/Money"},"paid_money":{"$ref":"#/components/schemas/Money"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"refunded_money":{"$ref":"#/components/schemas/Money"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["invoice_id","is_overdue","outstanding_money","paid_money","refunded_money","status"],"type":"object"},"ExpandedOrderSummary":{"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"customer_id":{"type":"string"},"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled","not_applicable","closed"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled.","Not applicable.","Closed."],"x-flint-enum":"open"},"order_id":{"type":"string"},"order_number":{"type":"string"},"payment_intent_ids":{"items":{"type":"string"},"type":"array"},"payment_status":{"enum":["unpaid","partially_paid","paid"],"type":"string","x-enum-descriptions":["Unpaid.","Partially paid.","Paid."],"x-flint-enum":"open"},"pricing_amounts":{"$ref":"#/components/schemas/PricingAmounts"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"settlement_amounts":{"$ref":"#/components/schemas/SettlementAmounts"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["order_id","payment_status","pricing_amounts","refund_status","settlement_amounts","status"],"type":"object"},"ExpandedOrganizationSummary":{"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"name":{"type":"string"},"organization_id":{"type":"string"},"parent_organization_id":{"type":"string"},"status":{"enum":["active","deleted"],"type":"string","x-enum-descriptions":["Active.","Deleted."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["name","organization_id","status"],"type":"object"},"ExpandedPackageSummary":{"properties":{"carrier":{"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"delivered_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"fulfillment_id":{"type":"string"},"package_id":{"type":"string"},"service_code":{"type":"string"},"shipment_id":{"type":"string"},"shipped_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"status":{"description":"Current package lifecycle state.\n- `created`: The package record exists but has not been packed or handed off.\n- `packed`: The package is packed and awaiting carrier handoff.\n- `shipped`: The package was handed to the carrier.\n- `in_transit`: The carrier is moving the package through its network.\n- `out_for_delivery`: The package is on its final delivery route.\n- `delivered`: The carrier reported successful delivery.\n- `delivery_attempted`: The carrier attempted delivery but did not complete it. Follow the carrier instructions before retrying delivery.\n- `exception`: A carrier exception is blocking normal progress. Resolve the carrier-reported issue.\n- `returned`: The package was returned toward or to its origin.\n- `voided`: The package was voided and will not continue through delivery.","enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open","x-flint-enum-descriptions":{"created":"The package record exists but has not been packed or handed off.","delivered":"The carrier reported successful delivery.","delivery_attempted":"The carrier attempted delivery but did not complete it. Follow the carrier instructions before retrying delivery.","exception":"A carrier exception is blocking normal progress. Resolve the carrier-reported issue.","in_transit":"The carrier is moving the package through its network.","out_for_delivery":"The package is on its final delivery route.","packed":"The package is packed and awaiting carrier handoff.","returned":"The package was returned toward or to its origin.","shipped":"The package was handed to the carrier.","voided":"The package was voided and will not continue through delivery."}},"supported_actions":{"description":"Read-only actions currently supported for this package.","items":{"enum":["mark_delivered","mark_delivery_attempted","mark_exception","mark_in_transit","mark_out_for_delivery","mark_packed","mark_returned","mark_shipped"],"type":"string","x-enum-descriptions":["Mark delivered.","Mark delivery attempted.","Mark exception.","Mark in transit.","Mark out for delivery.","Mark packed.","Mark returned.","Mark shipped."],"x-flint-enum":"closed"},"readOnly":true,"type":"array"},"tracking_number":{"type":"string"},"tracking_url":{"type":"string"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"version":{"description":"Monotonic package version for expected_version checks.","format":"uint64","minimum":1,"readOnly":true,"type":"integer"}},"required":["fulfillment_id","package_id","shipment_id","status","supported_actions","version"],"type":"object"},"ExpandedPaymentIntentSummary":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"capture_method":{"enum":["automatic","manual"],"type":"string","x-enum-descriptions":["Automatic.","Manual."],"x-flint-enum":"closed"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"customer_id":{"type":"string"},"order_id":{"type":"string"},"payment_intent_id":{"type":"string"},"payment_source":{"$ref":"#/components/schemas/PaymentSourceSummary"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"status":{"enum":["requires_payment_method","requires_confirmation","requires_action","processing","requires_capture","canceled","succeeded","expired"],"type":"string","x-enum-descriptions":["Requires payment method.","Requires confirmation.","Requires action.","Processing.","Requires capture.","Canceled.","Succeeded.","Expired."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["amount_money","payment_intent_id","status"],"type":"object"},"ExpandedPaymentLinkSummary":{"properties":{"completed_count":{"format":"int32","type":"integer"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"description":{"type":"string"},"name":{"type":"string"},"payment_link_id":{"type":"string"},"payment_link_type":{"enum":["standard","donation","event"],"type":"string","x-enum-descriptions":["Standard.","Donation.","Event."],"x-flint-enum":"closed"},"plan_id":{"type":"string"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"url":{"type":"string"}},"required":["completed_count","name","payment_link_id","status"],"type":"object"},"ExpandedPaymentMethodSummary":{"properties":{"card":{"$ref":"#/components/schemas/CardDetails"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"customer_id":{"type":"string"},"payment_method_id":{"type":"string"},"status":{"enum":["pending","active","expired","removed","failed"],"type":"string","x-enum-descriptions":["Pending.","Active.","Expired.","Removed.","Failed."],"x-flint-enum":"open"},"type":{"enum":["card"],"type":"string","x-enum-descriptions":["Card."],"x-flint-enum":"closed"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["payment_method_id","status","type"],"type":"object"},"ExpandedPayoutDestinationSummary":{"properties":{"available_payout_methods":{"items":{"enum":["standard"],"type":"string","x-enum-descriptions":["Standard."],"x-flint-enum":"closed"},"type":"array"},"bank_name":{"type":"string"},"country":{"description":"ISO 3166-1 alpha-2 country code.","example":"US","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"currency":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"},"default_for_currency":{"type":"boolean"},"last4":{"type":"string"},"payout_destination_id":{"type":"string"},"status":{"enum":["pending","active","verification_required","disabled","deleted","failed"],"type":"string","x-enum-descriptions":["Pending.","Active.","Verification required.","Disabled.","Deleted.","Failed."],"x-flint-enum":"open"},"type":{"enum":["bank_account","debit_card"],"type":"string","x-enum-descriptions":["Bank account.","Debit card."],"x-flint-enum":"closed"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["available_payout_methods","currency","default_for_currency","payout_destination_id","status","type"],"type":"object"},"ExpandedPayoutSummary":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"arrival_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"balance_source_type":{"enum":["card","bank_account","fpx"],"type":"string","x-enum-descriptions":["Card.","Bank account.","Fpx."],"x-flint-enum":"closed"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"currency":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"},"method":{"enum":["standard"],"type":"string","x-enum-descriptions":["Standard."],"x-flint-enum":"closed"},"payout_destination_id":{"type":"string"},"payout_id":{"type":"string"},"reversal_status":{"enum":["none","reversing","reversed"],"type":"string","x-enum-descriptions":["None.","Reversing.","Reversed."],"x-flint-enum":"open"},"status":{"enum":["pending","in_transit","paid","failed","canceled"],"type":"string","x-enum-descriptions":["Pending.","In transit.","Paid.","Failed.","Canceled."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["amount_money","currency","method","payout_id","reversal_status","status"],"type":"object"},"ExpandedShipmentSummary":{"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"delivered_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"direction":{"enum":["outbound","return"],"type":"string","x-enum-descriptions":["Outbound.","Return."],"x-flint-enum":"closed"},"fulfillment_id":{"type":"string"},"handed_off_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"package_count":{"description":"Total number of packages attached to the shipment, including voided packages.","format":"int32","minimum":0,"readOnly":true,"type":"integer"},"shipment_id":{"type":"string"},"shipped_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"status":{"description":"Read-only shipment state.\n- `created`: The shipment leg exists but has not been packed or handed off.\n- `packed`: The shipment leg is packed and awaiting carrier handoff.\n- `shipped`: The shipment leg was handed to the carrier.\n- `in_transit`: The carrier is moving the shipment through its network.\n- `out_for_delivery`: The shipment is on its final delivery route.\n- `delivered`: The carrier reported successful delivery.\n- `delivery_attempted`: The carrier attempted delivery but did not complete it. Follow the carrier instructions before retrying delivery.\n- `exception`: A carrier exception is blocking normal progress. Resolve the carrier-reported issue.\n- `returned`: The shipment was returned toward or to its origin.\n- `voided`: The shipment was voided and will not continue through delivery.","enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open","x-flint-enum-descriptions":{"created":"The shipment leg exists but has not been packed or handed off.","delivered":"The carrier reported successful delivery.","delivery_attempted":"The carrier attempted delivery but did not complete it. Follow the carrier instructions before retrying delivery.","exception":"A carrier exception is blocking normal progress. Resolve the carrier-reported issue.","in_transit":"The carrier is moving the shipment through its network.","out_for_delivery":"The shipment is on its final delivery route.","packed":"The shipment leg is packed and awaiting carrier handoff.","returned":"The shipment was returned toward or to its origin.","shipped":"The shipment leg was handed to the carrier.","voided":"The shipment was voided and will not continue through delivery."}},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["direction","fulfillment_id","package_count","shipment_id","status"],"type":"object"},"ExpandedSubscriptionPlanSummary":{"properties":{"billing_interval":{"enum":["daily","weekly","monthly","yearly"],"type":"string","x-enum-descriptions":["Daily.","Weekly.","Monthly.","Yearly."],"x-flint-enum":"closed"},"billing_interval_count":{"format":"int32","type":"integer"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"currency":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"},"description":{"type":"string"},"line_items":{"items":{"$ref":"#/components/schemas/SubscriptionPlanLineItem"},"type":"array"},"name":{"type":"string"},"plan_id":{"type":"string"},"setup_fee_money":{"$ref":"#/components/schemas/Money"},"status":{"enum":["active","archived"],"type":"string","x-enum-descriptions":["Active.","Archived."],"x-flint-enum":"open"},"trial_period_days":{"format":"int32","type":"integer"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["billing_interval","billing_interval_count","currency","name","plan_id","status"],"type":"object"},"ExpandedSubscriptionSummary":{"properties":{"billing_anchor_day":{"format":"int32","type":"integer"},"cancel_at_period_end":{"type":"boolean"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"current_period_end":{"type":"string"},"current_period_start":{"type":"string"},"customer_id":{"type":"string"},"next_billing_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"plan_id":{"type":"string"},"status":{"enum":["trialing","active","paused","past_due","canceled","incomplete"],"type":"string","x-enum-descriptions":["Trialing.","Active.","Paused.","Past due.","Canceled.","Incomplete."],"x-flint-enum":"open"},"subscription_id":{"type":"string"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["billing_anchor_day","cancel_at_period_end","customer_id","plan_id","status","subscription_id"],"type":"object"},"FeedbackReport":{"additionalProperties":false,"oneOf":[{"properties":{"kind":{"enum":["rating"],"type":"string","x-enum-descriptions":["Structured positive, negative, or neutral sentiment, with optional narrative context."],"x-flint-enum":"closed"}},"required":["kind","surface","sentiment"]},{"properties":{"kind":{"enum":["papercut","bug","feature_request","praise","other"],"type":"string","x-enum-descriptions":["An existing Flint workflow works, but avoidable friction or unclear developer experience makes it harder than necessary.","Flint behavior is broken, incorrect, or contradicts its public contract.","The caller needs a capability Flint does not provide.","Narrative positive feedback about an experience.","Feedback that does not match the other classifications."],"x-flint-enum":"closed"}},"required":["kind","surface","summary"]}],"properties":{"actual_behavior":{"maxLength":4000,"minLength":1,"type":"string"},"canonical_command":{"maxLength":200,"minLength":1,"pattern":"^[a-z][a-z0-9]*(?:[.-][a-z0-9]+)*$","type":"string"},"code_location":{"maxLength":500,"minLength":1,"type":"string"},"component":{"maxLength":128,"minLength":1,"type":"string"},"created_at":{"description":"When Flint stored the report.","format":"date-time","readOnly":true,"type":"string"},"description":{"maxLength":8000,"minLength":1,"type":"string"},"expected_behavior":{"maxLength":4000,"minLength":1,"type":"string"},"feedback_report_id":{"pattern":"^fbr_[0-9A-HJKMNP-TV-Z]{26}$","readOnly":true,"type":"string"},"kind":{"enum":["papercut","bug","feature_request","rating","praise","other"],"type":"string","x-enum-descriptions":["An existing Flint workflow works, but avoidable friction or unclear developer experience makes it harder than necessary.","Flint behavior is broken, incorrect, or contradicts its public contract.","The caller needs a capability Flint does not provide.","Structured positive, negative, or neutral sentiment, with optional narrative context.","Narrative positive feedback about an experience.","Feedback that does not match the other classifications."],"x-flint-enum":"closed"},"related_request_id":{"maxLength":255,"minLength":1,"type":"string"},"related_resource_ids":{"items":{"minLength":1,"type":"string"},"maxItems":20,"type":"array","uniqueItems":true},"reporter_kind":{"enum":["human","ai_agent"],"type":"string","x-enum-descriptions":["Human.","Ai agent."],"x-flint-enum":"closed"},"reporting_client":{"$ref":"#/components/schemas/FeedbackReportingClient"},"reproduction_steps":{"items":{"maxLength":1000,"minLength":1,"type":"string"},"maxItems":20,"type":"array","uniqueItems":true},"sentiment":{"enum":["positive","negative","neutral"],"type":"string","x-enum-descriptions":["Positive.","Negative.","Neutral."],"x-flint-enum":"closed"},"summary":{"maxLength":200,"minLength":1,"type":"string"},"surface":{"enum":["api","cli","mcp","sdk","docs","dashboard","checkout","payment_links","webhooks","onboarding","mobile","other"],"type":"string","x-enum-descriptions":["Api.","Cli.","Mcp.","Sdk.","Docs.","Dashboard.","Checkout.","Payment links.","Webhooks.","Onboarding.","Mobile.","Other."],"x-flint-enum":"closed"},"surface_route":{"maxLength":500,"minLength":1,"type":"string"}},"required":["created_at","feedback_report_id","kind","surface"],"type":"object"},"FeedbackReportListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/FeedbackReport"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"FeedbackReportResponse":{"properties":{"data":{"$ref":"#/components/schemas/FeedbackReport"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"FeedbackReportingClient":{"additionalProperties":false,"properties":{"name":{"maxLength":64,"minLength":1,"type":"string"},"platform":{"enum":["macos","linux","windows","ios","android","web","other"],"type":"string","x-enum-descriptions":["Macos.","Linux.","Windows.","Ios.","Android.","Web.","Other."],"x-flint-enum":"closed"},"schema_version":{"maxLength":64,"minLength":1,"type":"string"},"version":{"maxLength":64,"minLength":1,"type":"string"}},"required":["name"],"type":"object"},"FraudWarning":{"properties":{"actionable":{"type":"boolean"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"dispute":{"anyOf":[{"$ref":"#/components/schemas/Dispute"},{"type":"null"}]},"dispute_id":{"type":["string","null"]},"fraud_type":{"enum":["card_never_received","fraudulent_card_application","made_with_counterfeit_card","made_with_lost_card","made_with_stolen_card","unauthorized_use_of_card","other"],"type":"string","x-enum-descriptions":["Card never received.","Fraudulent card application.","Made with counterfeit card.","Made with lost card.","Made with stolen card.","Unauthorized use of card.","Other."],"x-flint-enum":"closed"},"fraud_warning_id":{"type":"string"},"payment_intent":{"anyOf":[{"$ref":"#/components/schemas/ExpandedPaymentIntentSummary"},{"type":"null"}]},"payment_intent_id":{"type":"string"},"payment_summary":{"$ref":"#/components/schemas/PublicFraudWarningPaymentSummary"},"reported_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["fraud_warning_id","payment_intent_id","fraud_type","actionable","dispute_id","payment_summary","reported_at","created_at"],"type":"object"},"FraudWarningListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/FraudWarning"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"FraudWarningResponse":{"properties":{"data":{"$ref":"#/components/schemas/FraudWarning"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"Fulfillment":{"properties":{"active_hold":{"$ref":"#/components/schemas/FulfillmentHold","description":"Current hold details. While this field is present, status continues to show the public work status from before the hold.","readOnly":true},"charges":{"items":{"$ref":"#/components/schemas/FulfillmentChargeLink"},"readOnly":true,"type":"array"},"completed_at":{"description":"Completion evidence timestamp.","format":"date-time","type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"digital_details":{"$ref":"#/components/schemas/DigitalFulfillmentDetails"},"dispatched_at":{"description":"First time this fulfillment reached dispatched.","format":"date-time","readOnly":true,"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"fulfillment_id":{"readOnly":true,"type":"string"},"line_items":{"items":{"$ref":"#/components/schemas/FulfillmentLineItem"},"type":"array"},"local_delivery_details":{"$ref":"#/components/schemas/DeliveryFulfillmentDetails"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrderSummary"},{"type":"null"}],"readOnly":true},"order_id":{"readOnly":true,"type":"string"},"outcome":{"$ref":"#/components/schemas/FulfillmentOutcome","description":"Terminal outcome details. The mark_no_show action records its reason here and returns status as failed.","readOnly":true},"packages":{"items":{"$ref":"#/components/schemas/ExpandedPackageSummary"},"readOnly":true,"type":"array"},"packed_at":{"description":"First time this fulfillment reached packed.","format":"date-time","readOnly":true,"type":"string"},"picked_at":{"description":"First time this fulfillment reached picked.","format":"date-time","readOnly":true,"type":"string"},"pickup_details":{"$ref":"#/components/schemas/PickupFulfillmentDetails"},"quantity_effect":{"description":"Read-only current quantity accounting behavior for this fulfillment state.","enum":["preserve","fulfill","release"],"readOnly":true,"type":"string","x-enum-descriptions":["Preserve.","Fulfill.","Release."],"x-flint-enum":"closed"},"recipient":{"$ref":"#/components/schemas/FulfillmentRecipient"},"request_status":{"description":"Provider acceptance state, independent from fulfillment work progress. The accept action sets this field to accepted while status remains pending.","enum":["pending","accepted"],"readOnly":true,"type":"string","x-enum-descriptions":["Pending.","Accepted."],"x-flint-enum":"open"},"service_details":{"$ref":"#/components/schemas/ServiceFulfillmentDetails"},"shipments":{"items":{"$ref":"#/components/schemas/ExpandedShipmentSummary"},"readOnly":true,"type":"array"},"status":{"description":"Public work status. Fulfillments with request_status accepted project to status pending. Fulfillments with outcome.outcome_type no_show project to status failed. A fulfillment with active_hold projects to its public work status from before the hold.\n- `pending`: Work has not started. Start, schedule, accept, hold, cancel, or fail it as supported_actions allows.\n- `in_progress`: Work has started and is not yet ready or complete.\n- `ready`: The fulfillment is ready for pickup, handoff, or completion.\n- `completed`: All fulfillment work completed successfully.\n- `canceled`: The fulfillment was intentionally canceled and will not continue.\n- `failed`: The fulfillment could not be completed. Resolve the recorded reason before creating replacement work.\n- `scheduled`: The fulfillment is scheduled for its recorded service window.\n- `preparing`: Warehouse or provider preparation is underway.\n- `picked`: The assigned items have been picked.\n- `packed`: The assigned items have been packed.\n- `dispatched`: The fulfillment left its origin for delivery or handoff.","enum":["pending","in_progress","ready","completed","canceled","failed","scheduled","preparing","picked","packed","dispatched"],"readOnly":true,"type":"string","x-enum-descriptions":["Pending.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Preparing.","Picked.","Packed.","Dispatched."],"x-flint-enum":"open","x-flint-enum-descriptions":{"canceled":"The fulfillment was intentionally canceled and will not continue.","completed":"All fulfillment work completed successfully.","dispatched":"The fulfillment left its origin for delivery or handoff.","failed":"The fulfillment could not be completed. Resolve the recorded reason before creating replacement work.","in_progress":"Work has started and is not yet ready or complete.","packed":"The assigned items have been packed.","pending":"Work has not started. Start, schedule, accept, hold, cancel, or fail it as supported_actions allows.","picked":"The assigned items have been picked.","preparing":"Warehouse or provider preparation is underway.","ready":"The fulfillment is ready for pickup, handoff, or completion.","scheduled":"The fulfillment is scheduled for its recorded service window."}},"supported_actions":{"description":"Read-only actions currently supported for this fulfillment.","items":{"enum":["complete","cancel","hold","start","mark_ready","fail","schedule","accept","mark_preparing","mark_picked","mark_packed","dispatch","mark_no_show"],"type":"string","x-enum-descriptions":["Complete.","Cancel.","Hold.","Start.","Mark ready.","Fail.","Schedule.","Accept.","Mark preparing.","Mark picked.","Mark packed.","Dispatch.","Mark no show."],"x-flint-enum":"closed"},"readOnly":true,"type":"array"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"version":{"description":"Monotonic fulfillment version for expected_version checks.","format":"uint64","minimum":1,"readOnly":true,"type":"integer"}},"required":["fulfillment_id","line_items","order_id","request_status","status","supported_actions","type","version"],"type":"object"},"FulfillmentChargeLink":{"properties":{"order_charge_id":{"type":"string"}},"required":["order_charge_id"],"type":"object"},"FulfillmentCommandResponse":{"properties":{"data":{"$ref":"#/components/schemas/FulfillmentCommandResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"FulfillmentCommandResult":{"properties":{"event":{"$ref":"#/components/schemas/FulfillmentEvent"},"fulfillment":{"$ref":"#/components/schemas/Fulfillment"},"fulfillment_notifications":{"items":{"$ref":"#/components/schemas/FulfillmentNotification"},"type":"array"},"unchanged":{"type":"boolean"}},"required":["fulfillment"],"type":"object"},"FulfillmentEvent":{"properties":{"buyer_notification_behavior":{"description":"Controls buyer email handling. Omit or use send to send when recipient, template, and deduplication rules allow it. Use suppress when another system owns buyer messaging.","enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"created_at":{"description":"Timeline entry creation timestamp.","format":"date-time","readOnly":true,"type":"string"},"current_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show","created","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"readOnly":true,"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show.","Created.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"custom_details":{"additionalProperties":{"type":"string"},"type":"object"},"event_type":{"enum":["status_changed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","tracking_updated","exception","returned","custom"],"type":"string","x-enum-descriptions":["Status changed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Tracking updated.","Exception.","Returned.","Custom."],"x-flint-enum":"closed"},"external_event_id":{"type":"string"},"external_status":{"type":"string"},"external_system":{"type":"string"},"fulfillment_event_id":{"readOnly":true,"type":"string"},"fulfillment_id":{"readOnly":true,"type":"string"},"location_description":{"type":"string"},"message":{"type":"string"},"occurred_at":{"description":"Provider event timestamp.","format":"date-time","type":"string"},"order":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrderSummary"},{"type":"null"}],"readOnly":true},"order_id":{"readOnly":true,"type":"string"},"package_id":{"readOnly":true,"type":"string"},"previous_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show","created","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"readOnly":true,"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show.","Created.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"quantity_effect":{"enum":["preserve","fulfill","release"],"readOnly":true,"type":"string","x-enum-descriptions":["Preserve.","Fulfill.","Release."],"x-flint-enum":"closed"},"reason":{"readOnly":true,"type":"string"},"received_at":{"description":"Flint receive timestamp.","format":"date-time","readOnly":true,"type":"string"},"shipment_id":{"readOnly":true,"type":"string"},"subject_type":{"enum":["fulfillment","shipment","package"],"readOnly":true,"type":"string","x-enum-descriptions":["Fulfillment.","Shipment.","Package."],"x-flint-enum":"closed"}},"required":["buyer_notification_behavior","event_type","fulfillment_event_id","fulfillment_id","order_id","subject_type"],"type":"object"},"FulfillmentEventListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/FulfillmentEvent"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"FulfillmentEventResourceResponse":{"properties":{"data":{"$ref":"#/components/schemas/FulfillmentEvent"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"FulfillmentEventResponse":{"properties":{"data":{"$ref":"#/components/schemas/FulfillmentEventResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"FulfillmentEventResult":{"properties":{"fulfillment":{"$ref":"#/components/schemas/Fulfillment"},"fulfillment_event":{"$ref":"#/components/schemas/FulfillmentEvent"},"fulfillment_notifications":{"items":{"$ref":"#/components/schemas/FulfillmentNotification"},"type":"array"},"package":{"$ref":"#/components/schemas/Package"},"replayed":{"type":"boolean"},"shipment":{"$ref":"#/components/schemas/Shipment"}},"required":["fulfillment_event"],"type":"object"},"FulfillmentHold":{"properties":{"created_at":{"description":"Time the hold became active.","format":"date-time","type":"string"},"display_reason":{"type":"string"},"held_by":{"type":"string"},"reason":{"enum":["payment_review","inventory_issue","address_issue","customer_request","provider_issue","scheduling_issue","fraud_review","other"],"type":"string","x-enum-descriptions":["Payment review.","Inventory issue.","Address issue.","Customer request.","Provider issue.","Scheduling issue.","Fraud review.","Other."],"x-flint-enum":"closed"},"reason_notes":{"type":"string"}},"required":["created_at","reason"],"type":"object"},"FulfillmentLineItem":{"properties":{"modifiers":{"items":{"$ref":"#/components/schemas/OrderLineItemModifier"},"type":"array"},"order_line_item_id":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"}},"required":["order_line_item_id","quantity"],"type":"object"},"FulfillmentLineItemInput":{"properties":{"order_line_item_id":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"}},"required":["order_line_item_id","quantity"],"type":"object"},"FulfillmentListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Fulfillment"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"FulfillmentNotification":{"properties":{"channel":{"enum":["email"],"type":"string","x-enum-descriptions":["Email."],"x-flint-enum":"closed"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"failed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"fulfillment_event_id":{"type":"string"},"fulfillment_id":{"type":"string"},"fulfillment_notification_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"notification_type":{"enum":["fulfillment_ready","fulfillment_dispatched","fulfillment_completed","fulfillment_canceled","fulfillment_failed","fulfillment_no_show","fulfillment_shipped","fulfillment_in_transit","fulfillment_out_for_delivery","fulfillment_delivered","fulfillment_delivery_attempted","fulfillment_exception","fulfillment_returned","tracking_updated","shipment_shipped","shipment_in_transit","shipment_out_for_delivery","shipment_delivered","shipment_delivery_attempted","shipment_exception","shipment_returned"],"type":"string","x-enum-descriptions":["Fulfillment ready.","Fulfillment dispatched.","Fulfillment completed.","Fulfillment canceled.","Fulfillment failed.","Fulfillment no show.","Fulfillment shipped.","Fulfillment in transit.","Fulfillment out for delivery.","Fulfillment delivered.","Fulfillment delivery attempted.","Fulfillment exception.","Fulfillment returned.","Tracking updated.","Shipment shipped.","Shipment in transit.","Shipment out for delivery.","Shipment delivered.","Shipment delivery attempted.","Shipment exception.","Shipment returned."],"x-flint-enum":"closed"},"order":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrderSummary"},{"type":"null"}]},"order_id":{"type":"string"},"package_id":{"type":"string"},"recipient_customer_id":{"type":"string"},"recipient_email":{"type":"string"},"sent_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"shipment_id":{"type":"string"},"status":{"enum":["pending","suppressed"],"type":"string","x-enum-descriptions":["Pending.","Suppressed."],"x-flint-enum":"open"},"suppression_reason":{"enum":["source_suppressed","default_suppressed","recipient_missing","template_not_configured","merchant_managed_email","recipient_unsubscribed"],"type":"string","x-enum-descriptions":["Source suppressed.","Default suppressed.","Recipient missing.","Template not configured.","Merchant managed email.","Recipient unsubscribed."],"x-flint-enum":"closed"},"trigger_type":{"enum":["fulfillment_status_updated","fulfillment_event_created"],"type":"string","x-enum-descriptions":["Fulfillment status updated.","Fulfillment event created."],"x-flint-enum":"closed"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["channel","fulfillment_id","fulfillment_notification_id","notification_type","order_id","status","trigger_type"],"type":"object"},"FulfillmentNotificationListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/FulfillmentNotification"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"FulfillmentNotificationResponse":{"properties":{"data":{"$ref":"#/components/schemas/FulfillmentNotification"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"FulfillmentOutcome":{"properties":{"notes":{"type":"string"},"occurred_at":{"description":"Time the terminal outcome occurred.","format":"date-time","type":"string"},"outcome_type":{"enum":["no_show"],"type":"string","x-enum-descriptions":["No show."],"x-flint-enum":"closed"},"reason":{"enum":["customer_no_show","provider_no_show","location_unavailable","scheduling_error","other"],"type":"string","x-enum-descriptions":["Customer no show.","Provider no show.","Location unavailable.","Scheduling error.","Other."],"x-flint-enum":"closed"}},"required":["occurred_at","outcome_type","reason"],"type":"object"},"FulfillmentPackagingInput":{"additionalProperties":false,"discriminator":{"propertyName":"packaging"},"oneOf":[{"properties":{"packaging":{"enum":["single_package"],"type":"string","x-enum-descriptions":["Single package."],"x-flint-enum":"closed"}},"required":["packaging","package"]}],"properties":{"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"external_system":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"package":{"$ref":"#/components/schemas/CreatePackageRequest"},"packaging":{"type":"string"}},"required":["packaging"],"type":"object"},"FulfillmentRecipient":{"properties":{"address":{"$ref":"#/components/schemas/Address"},"email":{"type":"string"},"instructions":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"}},"type":"object"},"FulfillmentResponse":{"properties":{"data":{"$ref":"#/components/schemas/Fulfillment"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"FulfillmentSettings":{"properties":{"approval_required":{"type":"boolean"}},"type":"object"},"FulfillmentTransitionRequest":{"discriminator":{"mapping":{"accept":"#/components/schemas/FulfillmentTransitionRequestAccept","cancel":"#/components/schemas/FulfillmentTransitionRequestCancel","complete":"#/components/schemas/FulfillmentTransitionRequestComplete","dispatch":"#/components/schemas/FulfillmentTransitionRequestDispatch","fail":"#/components/schemas/FulfillmentTransitionRequestFail","hold":"#/components/schemas/FulfillmentTransitionRequestHold","mark_no_show":"#/components/schemas/FulfillmentTransitionRequestMarkNoShow","mark_packed":"#/components/schemas/FulfillmentTransitionRequestMarkPacked","mark_picked":"#/components/schemas/FulfillmentTransitionRequestMarkPicked","mark_preparing":"#/components/schemas/FulfillmentTransitionRequestMarkPreparing","mark_ready":"#/components/schemas/FulfillmentTransitionRequestMarkReady","schedule":"#/components/schemas/FulfillmentTransitionRequestSchedule","start":"#/components/schemas/FulfillmentTransitionRequestStart"},"propertyName":"action"},"oneOf":[{"$ref":"#/components/schemas/FulfillmentTransitionRequestComplete"},{"$ref":"#/components/schemas/FulfillmentTransitionRequestCancel"},{"$ref":"#/components/schemas/FulfillmentTransitionRequestHold"},{"$ref":"#/components/schemas/FulfillmentTransitionRequestStart"},{"$ref":"#/components/schemas/FulfillmentTransitionRequestMarkReady"},{"$ref":"#/components/schemas/FulfillmentTransitionRequestFail"},{"$ref":"#/components/schemas/FulfillmentTransitionRequestSchedule"},{"$ref":"#/components/schemas/FulfillmentTransitionRequestAccept"},{"$ref":"#/components/schemas/FulfillmentTransitionRequestMarkPreparing"},{"$ref":"#/components/schemas/FulfillmentTransitionRequestMarkPicked"},{"$ref":"#/components/schemas/FulfillmentTransitionRequestMarkPacked"},{"$ref":"#/components/schemas/FulfillmentTransitionRequestDispatch"},{"$ref":"#/components/schemas/FulfillmentTransitionRequestMarkNoShow"}]},"FulfillmentTransitionRequestAccept":{"additionalProperties":false,"properties":{"action":{"enum":["accept"],"type":"string","x-enum-descriptions":["Accept."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"maxLength":500,"type":"string"}},"required":["action"],"type":"object"},"FulfillmentTransitionRequestCancel":{"additionalProperties":false,"properties":{"action":{"enum":["cancel"],"type":"string","x-enum-descriptions":["Cancel."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"reason":{"maxLength":500,"type":"string"}},"required":["action"],"type":"object"},"FulfillmentTransitionRequestComplete":{"additionalProperties":false,"properties":{"action":{"enum":["complete"],"type":"string","x-enum-descriptions":["Complete."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"completed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"reason":{"maxLength":500,"type":"string"}},"required":["action"],"type":"object"},"FulfillmentTransitionRequestDispatch":{"additionalProperties":false,"properties":{"action":{"enum":["dispatch"],"type":"string","x-enum-descriptions":["Dispatch."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"maxLength":500,"type":"string"}},"required":["action"],"type":"object"},"FulfillmentTransitionRequestFail":{"additionalProperties":false,"properties":{"action":{"enum":["fail"],"type":"string","x-enum-descriptions":["Fail."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"maxLength":500,"type":"string"},"release_quantity":{"type":"boolean"}},"required":["action","release_quantity"],"type":"object"},"FulfillmentTransitionRequestHold":{"additionalProperties":false,"properties":{"action":{"enum":["hold"],"type":"string","x-enum-descriptions":["Hold."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"enum":["payment_review","inventory_issue","address_issue","customer_request","provider_issue","scheduling_issue","fraud_review","other"],"type":"string","x-enum-descriptions":["Payment review.","Inventory issue.","Address issue.","Customer request.","Provider issue.","Scheduling issue.","Fraud review.","Other."],"x-flint-enum":"closed"}},"required":["action","reason"],"type":"object"},"FulfillmentTransitionRequestMarkNoShow":{"additionalProperties":false,"properties":{"action":{"enum":["mark_no_show"],"type":"string","x-enum-descriptions":["Mark no show."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"enum":["customer_no_show","provider_no_show","location_unavailable","scheduling_error","other"],"type":"string","x-enum-descriptions":["Customer no show.","Provider no show.","Location unavailable.","Scheduling error.","Other."],"x-flint-enum":"closed"}},"required":["action","reason"],"type":"object"},"FulfillmentTransitionRequestMarkPacked":{"additionalProperties":false,"properties":{"action":{"enum":["mark_packed"],"type":"string","x-enum-descriptions":["Mark packed."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"maxLength":500,"type":"string"}},"required":["action"],"type":"object"},"FulfillmentTransitionRequestMarkPicked":{"additionalProperties":false,"properties":{"action":{"enum":["mark_picked"],"type":"string","x-enum-descriptions":["Mark picked."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"maxLength":500,"type":"string"}},"required":["action"],"type":"object"},"FulfillmentTransitionRequestMarkPreparing":{"additionalProperties":false,"properties":{"action":{"enum":["mark_preparing"],"type":"string","x-enum-descriptions":["Mark preparing."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"maxLength":500,"type":"string"}},"required":["action"],"type":"object"},"FulfillmentTransitionRequestMarkReady":{"additionalProperties":false,"properties":{"action":{"enum":["mark_ready"],"type":"string","x-enum-descriptions":["Mark ready."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"maxLength":500,"type":"string"}},"required":["action"],"type":"object"},"FulfillmentTransitionRequestSchedule":{"additionalProperties":false,"properties":{"action":{"enum":["schedule"],"type":"string","x-enum-descriptions":["Schedule."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"maxLength":500,"type":"string"},"scheduled_end_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"scheduled_start_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["action","scheduled_start_at","scheduled_end_at"],"type":"object"},"FulfillmentTransitionRequestStart":{"additionalProperties":false,"properties":{"action":{"enum":["start"],"type":"string","x-enum-descriptions":["Start."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"maxLength":500,"type":"string"}},"required":["action"],"type":"object"},"GetOrCreateReturnResolutionCheckoutSessionResponse":{"properties":{"data":{"$ref":"#/components/schemas/CheckoutSessionLaunchResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"GetPaymentIntentResponse":{"properties":{"data":{"$ref":"#/components/schemas/GetPaymentIntentResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"GetPaymentIntentResult":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"authorization_expires_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"authorized_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"authorized_money":{"$ref":"#/components/schemas/Money","readOnly":true},"cancellation_reason":{"description":"Flint-normalized reason the payment intent was canceled. Unknown processor values are returned as payment_canceled.","enum":["requested_by_customer","duplicate","fraudulent","abandoned","authorization_expired","invoice_payment_failed","invoice_voided","payment_canceled"],"readOnly":true,"type":"string","x-enum-descriptions":["Requested by customer.","Duplicate.","Fraudulent.","Abandoned.","Authorization expired.","Invoice payment failed.","Invoice voided.","Payment canceled."],"x-flint-enum":"closed"},"capturable_money":{"$ref":"#/components/schemas/Money","readOnly":true},"capture_method":{"enum":["automatic","manual"],"type":"string","x-enum-descriptions":["Automatic.","Manual."],"x-flint-enum":"closed"},"captured_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"captured_money":{"$ref":"#/components/schemas/Money","readOnly":true},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"current_payment_action":{"$ref":"#/components/schemas/PendingPaymentAction","description":"Typed browser authority for the current standalone payment action. Complete it, then call the same confirm endpoint without a replacement credential. Absent when no browser action is required.","readOnly":true},"customer":{"anyOf":[{"$ref":"#/components/schemas/ExpandedCustomerSummary"},{"type":"null"}],"readOnly":true},"customer_id":{"type":"string"},"dispute_status":{"enum":["none","warning_needs_response","warning_under_review","warning_closed","needs_response","under_review","won","lost","prevented"],"readOnly":true,"type":"string","x-enum-descriptions":["None.","Warning needs response.","Warning under review.","Warning closed.","Needs response.","Under review.","Won.","Lost.","Prevented."],"x-flint-enum":"open"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"fulfillment_hold":{"$ref":"#/components/schemas/PaymentFulfillmentHold","readOnly":true},"invoice":{"anyOf":[{"$ref":"#/components/schemas/ExpandedInvoiceSummary"},{"type":"null"}],"readOnly":true},"invoice_id":{"readOnly":true,"type":"string"},"last_payment_error":{"$ref":"#/components/schemas/PaymentErrorSummary","readOnly":true},"merchant_id":{"readOnly":true,"type":"string"},"merchant_net_money":{"$ref":"#/components/schemas/Money","description":"Captured amount minus processing_fee_money. Later merchant assessments and credits are separate balance effects.","readOnly":true},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrderSummary"},{"type":"null"}],"readOnly":true},"order_id":{"readOnly":true,"type":"string"},"origin":{"enum":["virtual_terminal","payment_link","checkout","api","subscription"],"readOnly":true,"type":"string","x-enum-descriptions":["Virtual terminal.","Payment link.","Checkout.","Api.","Subscription."],"x-flint-enum":"closed"},"payment_collection":{"$ref":"#/components/schemas/PaymentCollection"},"payment_flow":{"enum":["checkout","payment_link","invoice","subscription_initial","subscription_renewal","virtual_terminal","api"],"readOnly":true,"type":"string","x-enum-descriptions":["Checkout.","Payment link.","Invoice.","Subscription initial.","Subscription renewal.","Virtual terminal.","Api."],"x-flint-enum":"closed"},"payment_intent_id":{"readOnly":true,"type":"string"},"payment_options":{"items":{"enum":["card","apple_pay","google_pay","affirm","ach_debit"],"type":"string","x-enum-descriptions":["Card.","Apple pay.","Google pay.","Affirm.","Ach debit."],"x-flint-enum":"closed"},"type":"array"},"payment_source":{"$ref":"#/components/schemas/PaymentSourceSummary","readOnly":true},"processing_fee_money":{"$ref":"#/components/schemas/Money","description":"Flint's all-in processing fee for this payment. It is the complete price Flint charges to process the payment, never a provider cost passed through. The fee is final once the card payment is captured or the ACH payment succeeds; canceled payments and failures before success have none. Your net for the payment is captured_money minus this fee. Refunds do not return or revise it.","readOnly":true},"receipt_email":{"type":"string"},"refund_status":{"enum":["none","partially_refunded","refunded"],"readOnly":true,"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"refunded_money":{"$ref":"#/components/schemas/Money","readOnly":true},"released_money":{"$ref":"#/components/schemas/Money","readOnly":true},"risk":{"$ref":"#/components/schemas/PaymentRisk","readOnly":true},"selected_payment_option":{"readOnly":true,"type":"string"},"settlement_status":{"enum":["none","partially_refunded","refunded","disputed"],"readOnly":true,"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded.","Disputed."],"x-flint-enum":"open"},"status":{"enum":["requires_payment_method","requires_confirmation","requires_action","processing","requires_capture","canceled","succeeded","expired"],"readOnly":true,"type":"string","x-enum-descriptions":["Requires payment method.","Requires confirmation.","Requires action.","Processing.","Requires capture.","Canceled.","Succeeded.","Expired."],"x-flint-enum":"open"},"support_reference":{"description":"Opaque payment reference to share with merchant support. Do not parse its format.","readOnly":true,"type":"string"},"tip_money":{"$ref":"#/components/schemas/Money"},"transaction_purpose":{"enum":["goods","services","other"],"type":"string","x-enum-descriptions":["Goods.","Services.","Other."],"x-flint-enum":"closed"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"}},"required":["amount_money","payment_flow","payment_intent_id","payment_options","status","support_reference"],"type":"object"},"GetReturnDispositionResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnDisposition"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"GetReturnInspectionResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnInspection"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"GetReturnLineItemResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnLineItem"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"GetReturnPolicyResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnPolicy"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"GetReturnPolicyRevisionResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnPolicyRevision"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"GetReturnReasonResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnReason"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"GetReturnReceiptResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnReceipt"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"GetReturnResolutionResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnResolution"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"GetReturnResponse":{"properties":{"data":{"$ref":"#/components/schemas/Return"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"GrantOrganizationMembershipRequest":{"properties":{"role":{"enum":["owner","admin","operator","viewer"],"type":"string","x-enum-descriptions":["Owner.","Admin.","Operator.","Viewer."],"x-flint-enum":"closed"},"user_id":{"type":"string"}},"required":["role","user_id"],"type":"object"},"HoldDetail":{"properties":{"held_money":{"$ref":"#/components/schemas/Money"},"released_money":{"$ref":"#/components/schemas/Money"},"used_money":{"$ref":"#/components/schemas/Money"}},"type":"object"},"HostedCheckout":{"description":"One-time hosted checkout access details for redirecting a buyer into Flint-hosted checkout.","properties":{"checkout_auth_token":{"description":"Checkout-session auth token for clients that operate the created checkout session directly. The hosted URL uses a separate launch credential.","type":"string"},"url":{"description":"Hosted checkout URL for the created or reused checkout session.","type":"string"}},"required":["checkout_auth_token","url"],"type":"object"},"Image":{"properties":{"alt":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"height":{"format":"int32","type":"integer"},"url":{"type":"string"},"width":{"format":"int32","type":"integer"}},"required":["height","url","width"],"type":"object"},"ImageInput":{"properties":{"alt":{"maxLength":512,"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"source_url":{"maxLength":8192,"minLength":1,"type":"string"}},"required":["source_url"],"type":"object"},"ImageReferenceInput":{"additionalProperties":false,"properties":{"alt":{"type":"string"},"url":{"type":"string"}},"required":["url"],"type":"object"},"InlineModifierGroupInput":{"additionalProperties":false,"properties":{"allow_quantities":{"default":false,"type":"boolean"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"max_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"max_selected":{"format":"int32","type":"integer"},"max_total_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"min_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"min_selected":{"format":"int32","type":"integer"},"modifier_group_id":{"pattern":"^mg_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"modifier_group_type":{"description":"Inferred as text when text configuration is supplied, otherwise list.","enum":["list","text"],"type":"string","x-enum-descriptions":["List.","Text."],"x-flint-enum":"closed"},"modifiers":{"items":{"$ref":"#/components/schemas/ModifierInput"},"type":"array"},"name":{"type":"string"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"text":{"$ref":"#/components/schemas/TextModifierConfigInput"}},"required":["name"],"type":"object"},"InventoryActionRequired":{"properties":{"inventory_reservation_line_ids":{"items":{"type":"string"},"type":"array"},"next_actions":{"items":{"enum":["replenish","reallocate","cancel"],"type":"string","x-enum-descriptions":["Replenish.","Reallocate.","Cancel."],"x-flint-enum":"closed"},"type":"array"},"reason":{"enum":["inventory_shortage"],"type":"string","x-enum-descriptions":["Inventory shortage."],"x-flint-enum":"closed"}},"required":["inventory_reservation_line_ids","next_actions","reason"],"type":"object"},"InventoryAdjustment":{"description":"A recorded physical stock change, such as receiving, damage, or a manual correction.","properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"external_actor_id":{"type":"string"},"idempotency_key":{"type":"string"},"inventory_adjustment_id":{"type":"string"},"lines":{"items":{"$ref":"#/components/schemas/AdjustmentLine"},"type":"array"},"note":{"type":"string"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"enum":["received_stock","damage","condition_changed","theft","loss","manual_correction","other"],"type":"string","x-enum-descriptions":["Received stock.","Damage.","Condition changed.","Theft.","Loss.","Manual correction.","Other."],"x-flint-enum":"closed"},"source_system":{"anyOf":[{"$ref":"#/components/schemas/InventorySourceSystem"},{"type":"null"}]}},"required":["created_at","idempotency_key","inventory_adjustment_id","lines","occurred_at","reason","source_system"],"type":"object"},"InventoryAdjustmentLineRequest":{"properties":{"damaged_quantity_delta":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"inventory_item_id":{"type":"string"},"location_id":{"type":"string"},"on_hand_quantity_delta":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"quality_control_quantity_delta":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"quarantined_quantity_delta":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"}},"required":["inventory_item_id","location_id"],"type":"object"},"InventoryAdjustmentListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InventoryAdjustment"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InventoryAdjustmentResult":{"properties":{"idempotency_key":{"type":"string"},"inventory_adjustment":{"$ref":"#/components/schemas/InventoryAdjustment"},"inventory_movement_ids":{"items":{"type":"string"},"type":"array"},"resulting_inventory_levels":{"description":"Post-commit state of every level this command touched, so no follow-up read is needed. A replay returns the levels the original command produced.","items":{"$ref":"#/components/schemas/InventoryLevel"},"type":"array"}},"required":["idempotency_key","inventory_adjustment","inventory_movement_ids","resulting_inventory_levels"],"type":"object"},"InventoryAdjustmentResultResponse":{"properties":{"data":{"$ref":"#/components/schemas/InventoryAdjustmentResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InventoryAllocationPolicy":{"description":"Named, version-fenced rules that decide which Locations serve demand and in what order.","properties":{"configuration":{"$ref":"#/components/schemas/InventoryAllocationPolicyConfiguration"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"inventory_allocation_policy_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"status":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"version":{"format":"uint64","minimum":0,"type":"integer"}},"required":["configuration","created_at","inventory_allocation_policy_id","metadata","name","status","updated_at","version"],"type":"object"},"InventoryAllocationPolicyConfiguration":{"additionalProperties":false,"properties":{"location_groups":{"description":"Locations ranked into priority groups. Routing prefers the lowest group priority, then the lowest location ID.","items":{"$ref":"#/components/schemas/PolicyLocation"},"maxItems":25,"minItems":1,"type":"array"},"maximum_locations_per_assignment":{"description":"Upper bound on how many Locations one assignment may use.","format":"int32","maximum":10,"minimum":1,"type":"integer"},"splitting_behavior":{"description":"single_location fails rather than splitting demand across Locations; split_when_required allows a split when no single Location can serve the whole request.","enum":["single_location","split_when_required"],"type":"string","x-enum-descriptions":["Single location.","Split when required."],"x-flint-enum":"closed"},"within_group_order":{"default":"location_id_ascending","description":"Tie-break inside a priority group. Ascending location ID keeps assignments reproducible.","enum":["location_id_ascending"],"type":"string","x-enum-descriptions":["Location id ascending."],"x-flint-enum":"closed"}},"required":["location_groups","maximum_locations_per_assignment","splitting_behavior"],"type":"object"},"InventoryAllocationPolicyListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InventoryAllocationPolicy"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InventoryAllocationPolicyResponse":{"properties":{"data":{"$ref":"#/components/schemas/InventoryAllocationPolicy"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InventoryAssignment":{"properties":{"demand_key":{"type":"string"},"geography_revision":{"format":"int64","type":"integer"},"inventory_item_id":{"type":"string"},"location_id":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"}},"required":["demand_key","geography_revision","inventory_item_id","location_id","quantity"],"type":"object"},"InventoryCount":{"properties":{"applied_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"idempotency_key":{"type":"string"},"inventory_count_id":{"type":"string"},"lines":{"items":{"$ref":"#/components/schemas/InventoryCountLine"},"type":"array"},"location_id":{"type":"string"},"observation_provenance":{"$ref":"#/components/schemas/CountProvenance"},"status":{"enum":["draft","applied","canceled"],"type":"string","x-enum-descriptions":["Draft.","Applied.","Canceled."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"version":{"format":"uint64","minimum":0,"type":"integer"}},"required":["created_at","idempotency_key","inventory_count_id","lines","location_id","status","updated_at","version"],"type":"object"},"InventoryCountLine":{"properties":{"captured_physical_revision":{"format":"uint64","minimum":0,"type":"integer"},"counted_damaged_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"counted_on_hand_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"counted_quality_control_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"counted_quarantined_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"damaged_variance":{"format":"int64","type":"integer"},"inventory_count_line_id":{"type":"string"},"inventory_item_id":{"type":"string"},"inventory_movement_id":{"type":"string"},"on_hand_variance":{"format":"int64","type":"integer"},"quality_control_variance":{"format":"int64","type":"integer"},"quarantined_variance":{"format":"int64","type":"integer"},"source_observation_sequence":{"format":"uint64","minimum":0,"type":"integer"}},"required":["captured_physical_revision","inventory_count_line_id","inventory_item_id"],"type":"object"},"InventoryCountListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InventoryCount"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InventoryCountObservationInput":{"additionalProperties":false,"properties":{"counted_damaged_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","minimum":0,"type":"integer"},"counted_on_hand_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","minimum":0,"type":"integer"},"counted_quality_control_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","minimum":0,"type":"integer"},"counted_quarantined_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","minimum":0,"type":"integer"},"inventory_item_id":{"type":"string"},"source_observation_sequence":{"format":"uint64","minimum":0,"type":"integer"}},"required":["counted_damaged_quantity","counted_on_hand_quantity","counted_quality_control_quantity","counted_quarantined_quantity","inventory_item_id"],"type":"object"},"InventoryCountResponse":{"properties":{"data":{"$ref":"#/components/schemas/InventoryCount"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InventoryCountResult":{"properties":{"idempotency_key":{"type":"string"},"inventory_count":{"$ref":"#/components/schemas/InventoryCount"},"inventory_movement_ids":{"items":{"type":"string"},"type":"array"},"resulting_inventory_levels":{"items":{"$ref":"#/components/schemas/InventoryLevel"},"type":"array"}},"required":["idempotency_key","inventory_count","inventory_movement_ids","resulting_inventory_levels"],"type":"object"},"InventoryCountResultResponse":{"properties":{"data":{"$ref":"#/components/schemas/InventoryCountResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InventoryCountTransitionRequest":{"additionalProperties":false,"properties":{"expected_version":{"format":"uint64","minimum":1,"type":"integer"}},"type":"object"},"InventoryItem":{"description":"A stock-keeping unit that inventory quantities are tracked against. Catalog variants reference an inventory item rather than carrying their own counter.","properties":{"barcode":{"description":"Optional searchable barcode.","type":"string"},"created_at":{"description":"Time the inventory item was created.","format":"date-time","type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"inventory_item_id":{"description":"Stable inventory item ID.","type":"string"},"metadata":{"additionalProperties":{"type":"string"},"description":"Caller-owned metadata.","type":"object"},"name":{"description":"Merchant-facing inventory item name.","type":"string"},"sku":{"description":"Optional searchable stock-keeping unit.","type":"string"},"status":{"description":"Current inventory item lifecycle status.","enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"},"updated_at":{"description":"Time the inventory item last changed.","format":"date-time","type":"string"},"version":{"description":"Optimistic-concurrency version for item writes.","format":"uint64","minimum":0,"type":"integer"}},"required":["created_at","inventory_item_id","metadata","name","status","updated_at","version"],"type":"object"},"InventoryItemCreateInput":{"properties":{"barcode":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"sku":{"type":"string"}},"required":["name"],"type":"object"},"InventoryItemListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InventoryItem"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InventoryItemResponse":{"properties":{"data":{"$ref":"#/components/schemas/InventoryItem"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InventoryLevel":{"description":"The quantity state of one inventory item at one Location.","properties":{"available_quantity":{"description":"Derived and never written: on_hand minus unavailable, held, committed, and safety stock. Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"committed_quantity":{"description":"Units promised to accepted orders. Still physically present until fulfillment consumes them. Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"damaged_quantity":{"description":"On-hand units known to be damaged. Not sellable. Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"held_quantity":{"description":"Units claimed by an open reservation that has not been committed. Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"incoming_quantity":{"description":"Units recorded as inbound but not yet on hand. Does not count toward availability. Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"inventory_item":{"$ref":"#/components/schemas/InventoryLevelItem","description":"Present on GET /v1/inventory-levels only. Levels returned by a command omit it."},"inventory_item_id":{"type":"string"},"inventory_level_claim_revision":{"description":"Advances only when held or committed quantities change.","format":"int64","type":"integer"},"inventory_level_id":{"type":"string"},"inventory_level_physical_revision":{"description":"Advances only when on-hand or condition quantities change.","format":"int64","type":"integer"},"location_id":{"type":"string"},"on_hand_quantity":{"description":"Units physically present at the Location, in any condition. Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"quality_control_quantity":{"description":"On-hand units awaiting inspection. Not sellable. Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"quarantined_quantity":{"description":"On-hand units isolated for review. Not sellable. Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"safety_stock_quantity":{"description":"Buffer withheld from allocation. Change it with PATCH /v1/inventory-levels/{inventory_level_id}. Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"shortage_quantity":{"description":"Derived: claims exceeding sellable physical stock. Positive only after stock is lost, damaged, or corrected down. Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"unavailable_on_hand_quantity":{"description":"Derived: quality_control + damaged + quarantined. Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"version":{"description":"Advances on any quantity change at this level.","format":"int64","type":"integer"}},"required":["available_quantity","committed_quantity","created_at","damaged_quantity","held_quantity","incoming_quantity","inventory_item_id","inventory_level_claim_revision","inventory_level_id","inventory_level_physical_revision","location_id","on_hand_quantity","quality_control_quantity","quarantined_quantity","safety_stock_quantity","shortage_quantity","unavailable_on_hand_quantity","updated_at","version"],"type":"object"},"InventoryLevelItem":{"description":"The inventory item this level belongs to, carried so a stock table does not need a read per row.","properties":{"barcode":{"type":"string"},"name":{"type":"string"},"sku":{"type":"string"},"status":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"}},"required":["name","status"],"type":"object"},"InventoryLevelListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InventoryLevel"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InventoryLevelUpdateResult":{"properties":{"idempotency_key":{"type":"string"},"inventory_level":{"$ref":"#/components/schemas/InventoryLevel"},"inventory_movement_ids":{"items":{"type":"string"},"type":"array"},"resulting_inventory_levels":{"description":"Post-commit state of every level this command touched, so no follow-up read is needed. A replay returns the levels the original command produced.","items":{"$ref":"#/components/schemas/InventoryLevel"},"type":"array"}},"required":["idempotency_key","inventory_level","inventory_movement_ids","resulting_inventory_levels"],"type":"object"},"InventoryLevelUpdateResultResponse":{"properties":{"data":{"$ref":"#/components/schemas/InventoryLevelUpdateResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InventoryMovement":{"description":"An immutable record of a single quantity change, including the level state it produced.","properties":{"committed_quantity_delta":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"created_by":{"type":"string"},"damaged_quantity_delta":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"external_actor_id":{"type":"string"},"held_quantity_delta":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"idempotency_key":{"type":"string"},"incoming_quantity_delta":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"inventory_item_id":{"type":"string"},"inventory_level_claim_revision":{"format":"uint64","minimum":0,"type":"integer"},"inventory_level_id":{"type":"string"},"inventory_level_physical_revision":{"format":"uint64","minimum":0,"type":"integer"},"inventory_level_revision":{"format":"uint64","minimum":0,"type":"integer"},"inventory_movement_id":{"type":"string"},"location_id":{"type":"string"},"note":{"type":"string"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"on_hand_quantity_delta":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"quality_control_quantity_delta":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"quarantined_quantity_delta":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"reason":{"type":"string"},"resulting_inventory_level":{"$ref":"#/components/schemas/InventoryLevel"},"return_disposition_id":{"type":"string"},"return_id":{"type":"string"},"safety_stock_quantity_delta":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"source_observation_sequence":{"format":"int64","type":"integer"},"source_reference":{"$ref":"#/components/schemas/InventorySourceReference"},"source_system":{"anyOf":[{"$ref":"#/components/schemas/InventorySourceSystem"},{"type":"null"}]},"type":{"type":"string"}},"required":["committed_quantity_delta","created_at","created_by","damaged_quantity_delta","held_quantity_delta","incoming_quantity_delta","inventory_item_id","inventory_level_claim_revision","inventory_level_id","inventory_level_physical_revision","inventory_level_revision","inventory_movement_id","location_id","occurred_at","on_hand_quantity_delta","quality_control_quantity_delta","quarantined_quantity_delta","reason","resulting_inventory_level","safety_stock_quantity_delta","source_system","type"],"type":"object"},"InventoryMovementListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InventoryMovement"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InventoryOriginPolicy":{"properties":{"post_payment_inventory_failure_action":{"enum":["exception_state","auto_refund"],"type":"string","x-enum-descriptions":["Exception state.","Auto refund."],"x-flint-enum":"closed"},"subscription_inventory_block_action":{"enum":["inventory_blocked_open_invoice","past_due"],"type":"string","x-enum-descriptions":["Inventory blocked open invoice.","Past due."],"x-flint-enum":"closed"}},"type":"object"},"InventoryReceipt":{"description":"A completed stock receipt. It can record a direct inventory intake or the stock effect of a customer Return disposition.","properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"external_actor_id":{"type":"string"},"idempotency_key":{"type":"string"},"inventory_receipt_id":{"type":"string"},"lines":{"items":{"$ref":"#/components/schemas/InventoryReceiptLine"},"type":"array"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"return_disposition_id":{"type":"string"},"return_id":{"type":"string"},"source_system":{"anyOf":[{"$ref":"#/components/schemas/InventorySourceSystem"},{"type":"null"}]}},"required":["created_at","idempotency_key","inventory_receipt_id","lines","occurred_at","source_system"],"type":"object"},"InventoryReceiptLine":{"properties":{"disposition":{"enum":["sellable","quality_control","damaged","quarantined","lost"],"type":"string","x-enum-descriptions":["Sellable.","Quality control.","Damaged.","Quarantined.","Lost."],"x-flint-enum":"closed"},"inventory_item_id":{"type":"string"},"inventory_movement_id":{"type":"string"},"inventory_receipt_line_id":{"type":"string"},"inventory_reservation_id":{"type":"string"},"inventory_reservation_line_id":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"receiving_location_id":{"type":"string"},"return_disposition_id":{"type":"string"},"return_line_item_id":{"type":"string"}},"required":["disposition","inventory_item_id","inventory_receipt_line_id","quantity","receiving_location_id"],"type":"object"},"InventoryReceiptLineInput":{"properties":{"disposition":{"enum":["sellable","quality_control","damaged","quarantined","lost"],"type":"string","x-enum-descriptions":["Sellable.","Quality control.","Damaged.","Quarantined.","Lost."],"x-flint-enum":"closed"},"inventory_item_id":{"type":"string"},"inventory_reservation_id":{"type":"string"},"inventory_reservation_line_id":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"receiving_location_id":{"type":"string"}},"required":["disposition","inventory_item_id","quantity","receiving_location_id"],"type":"object"},"InventoryReceiptListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InventoryReceipt"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InventoryReceiptResult":{"properties":{"idempotency_key":{"type":"string"},"inventory_movement_ids":{"items":{"type":"string"},"type":"array"},"inventory_receipt":{"$ref":"#/components/schemas/InventoryReceipt"},"resulting_inventory_levels":{"items":{"$ref":"#/components/schemas/InventoryLevel"},"type":"array"}},"required":["idempotency_key","inventory_movement_ids","inventory_receipt","resulting_inventory_levels"],"type":"object"},"InventoryReceiptResultResponse":{"properties":{"data":{"$ref":"#/components/schemas/InventoryReceiptResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InventoryReservation":{"description":"A claim on stock. Quantity moves from held to committed to consumed, and can be released or reallocated.","properties":{"closed_reason":{"description":"How the reservation ended. mixed when more than one terminal outcome applied.","enum":["consumed","released","expired","reallocated","mixed",null],"type":["string","null"],"x-enum-descriptions":["Consumed.","Released.","Expired.","Reallocated.","Mixed.","Null."],"x-flint-enum":"closed"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"idempotency_key":{"type":"string"},"inventory_action_required":{"$ref":"#/components/schemas/InventoryActionRequired","description":"Present when the claim needs a merchant action before commerce can continue."},"inventory_reservation_id":{"type":"string"},"inventory_routing_source":{"$ref":"#/components/schemas/InventoryRoutingSource"},"lines":{"items":{"$ref":"#/components/schemas/ReservationLine"},"type":"array"},"owner":{"$ref":"#/components/schemas/InventoryReservationOwner"},"replacement_inventory_reservation_id":{"type":"string"},"source_inventory_reservation_id":{"type":"string"},"status":{"description":"active while any held or committed quantity remains; closed once none does.","enum":["active","closed"],"type":"string","x-enum-descriptions":["Active.","Closed."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"version":{"format":"uint64","minimum":0,"type":"integer"}},"required":["created_at","idempotency_key","inventory_reservation_id","inventory_routing_source","lines","owner","status","updated_at","version"],"type":"object"},"InventoryReservationListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InventoryReservation"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InventoryReservationOwner":{"properties":{"expires_at":{"description":"Required deadline for the claim. On creation it can be at most 15 minutes out.","format":"date-time","type":"string"},"key":{"description":"Your stable identifier for what holds the stock, such as a cart ID. One active reservation per key.","type":"string"},"type":{"default":"merchant","enum":["merchant"],"type":"string","x-enum-descriptions":["Merchant."],"x-flint-enum":"closed"}},"required":["expires_at","key"],"type":"object"},"InventoryReservationProvenance":{"properties":{"external_actor_id":{"type":"string"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"source_system":{"$ref":"#/components/schemas/InventorySourceSystemInput"}},"type":"object"},"InventoryReservationResult":{"properties":{"idempotency_key":{"type":"string"},"inventory_movement_ids":{"items":{"type":"string"},"type":"array"},"inventory_reservation":{"$ref":"#/components/schemas/InventoryReservation"},"resulting_inventory_levels":{"description":"Post-commit state of every level this command touched, so no follow-up read is needed. A replay returns the levels the original command produced.","items":{"$ref":"#/components/schemas/InventoryLevel"},"type":"array"}},"required":["idempotency_key","inventory_movement_ids","inventory_reservation","resulting_inventory_levels"],"type":"object"},"InventoryReservationResultResponse":{"properties":{"data":{"$ref":"#/components/schemas/InventoryReservationResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InventoryRoutingDemand":{"properties":{"allowed_location_ids":{"items":{"type":"string"},"type":"array"},"bundle_component_id":{"type":"string"},"demand_key":{"type":"string"},"forced_location_id":{"type":"string"},"inventory_item_id":{"type":"string"},"order_line_item_id":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"splitting_behavior":{"enum":["single_location","split_when_required"],"type":"string","x-enum-descriptions":["Single location.","Split when required."],"x-flint-enum":"closed"}},"required":["demand_key","inventory_item_id","quantity","splitting_behavior"],"type":"object"},"InventoryRoutingSource":{"properties":{"inventory_allocation_policy_id":{"type":"string"},"inventory_allocation_policy_version_id":{"type":"string"},"location_id":{"type":"string"},"location_ids":{"items":{"type":"string"},"type":"array"},"type":{"enum":["fixed_location","policy","policy_version"],"type":"string","x-enum-descriptions":["Fixed location.","Policy.","Policy version."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"InventoryRoutingSourceInput":{"discriminator":{"propertyName":"type"},"oneOf":[{"additionalProperties":false,"properties":{"location_id":{"type":"string"},"type":{"enum":["fixed_location"],"type":"string","x-enum-descriptions":["Fixed location."],"x-flint-enum":"closed"}},"required":["type","location_id"],"type":"object"},{"additionalProperties":false,"properties":{"inventory_allocation_policy_id":{"type":"string"},"type":{"enum":["policy"],"type":"string","x-enum-descriptions":["Policy."],"x-flint-enum":"closed"}},"required":["type","inventory_allocation_policy_id"],"type":"object"},{"additionalProperties":false,"properties":{"inventory_allocation_policy_version_id":{"type":"string"},"type":{"enum":["policy_version"],"type":"string","x-enum-descriptions":["Policy version."],"x-flint-enum":"closed"}},"required":["type","inventory_allocation_policy_version_id"],"type":"object"}]},"InventorySettings":{"properties":{"low_stock_threshold":{"format":"int32","type":"integer"},"origin_policies":{"additionalProperties":{"$ref":"#/components/schemas/InventoryOriginPolicy"},"description":"Inventory failure handling keyed by order source: checkout, payment_link, api, subscription, virtual_terminal, or default. The source-specific entry wins; default applies to the rest.","type":"object"}},"type":"object"},"InventorySourceReference":{"properties":{"source_reference_id":{"type":"string"},"source_reference_type":{"enum":["fulfillment","inventory_reservation_line"],"type":"string","x-enum-descriptions":["Fulfillment.","Inventory reservation line."],"x-flint-enum":"closed"}},"required":["source_reference_id","source_reference_type"],"type":"object"},"InventorySourceSystem":{"properties":{"external_source_id":{"type":"string"},"type":{"enum":["manual","pos","wms","erp","flint","other"],"type":"string","x-enum-descriptions":["Manual.","Pos.","Wms.","Erp.","Flint.","Other."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"InventorySourceSystemInput":{"additionalProperties":false,"properties":{"external_source_id":{"type":"string"},"type":{"enum":["manual","pos","wms","erp","other"],"type":"string","x-enum-descriptions":["Manual.","Pos.","Wms.","Erp.","Other."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"InventoryTransfer":{"properties":{"closed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"closed_reason":{"enum":["received","canceled","received_with_cancellation","returned","lost","mixed",null],"type":["string","null"],"x-enum-descriptions":["Received.","Canceled.","Received with cancellation.","Returned.","Lost.","Mixed.","Null."],"x-flint-enum":"closed"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"departed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"destination_location_id":{"type":"string"},"external_reference":{"type":"string"},"idempotency_key":{"type":"string"},"inventory_transfer_id":{"type":"string"},"lines":{"items":{"$ref":"#/components/schemas/InventoryTransferLine"},"type":"array"},"note":{"type":"string"},"origin_location_id":{"type":"string"},"received_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"status":{"enum":["draft","in_transit","partially_resolved","closed"],"type":"string","x-enum-descriptions":["Draft.","In transit.","Partially resolved.","Closed."],"x-flint-enum":"open"},"supported_actions":{"items":{"enum":["depart","receive","return_to_origin","report_loss","cancel"],"type":"string","x-enum-descriptions":["Depart.","Receive.","Return to origin.","Report loss.","Cancel."],"x-flint-enum":"closed"},"readOnly":true,"type":"array"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"version":{"format":"uint64","minimum":0,"type":"integer"}},"required":["created_at","destination_location_id","idempotency_key","inventory_transfer_id","lines","origin_location_id","status","supported_actions","updated_at","version"],"type":"object"},"InventoryTransferActionConflictErrorDetail":{"allOf":[{"$ref":"#/components/schemas/ErrorDetail"},{"properties":{"code":{"enum":["INVENTORY_TRANSFER_ACTION_NOT_ALLOWED"],"type":"string","x-enum-descriptions":["INVENTORY TRANSFER ACTION NOT ALLOWED."],"x-flint-enum":"closed"},"current_status":{"description":"Current transfer status.","enum":["draft","in_transit","partially_resolved","closed"],"type":"string","x-enum-descriptions":["Draft.","In transit.","Partially resolved.","Closed."],"x-flint-enum":"open"},"current_version":{"description":"Current transfer version.","format":"uint64","minimum":1,"type":"integer"},"message":{"type":"string"},"param":{"enum":["action"],"type":"string","x-enum-descriptions":["Action."],"x-flint-enum":"closed"},"supported_actions":{"description":"Transfer actions accepted in the current state. A closed transfer returns an empty array.","items":{"enum":["depart","receive","return_to_origin","report_loss","cancel"],"type":"string","x-enum-descriptions":["Depart.","Receive.","Return to origin.","Report loss.","Cancel."],"x-flint-enum":"closed"},"type":"array"}},"required":["code","param","message","current_status","current_version","supported_actions"],"type":"object"}]},"InventoryTransferActionConflictErrorEnvelope":{"additionalProperties":false,"properties":{"error":{"$ref":"#/components/schemas/InventoryTransferActionConflictErrorObject"}},"required":["error"],"type":"object"},"InventoryTransferActionConflictErrorObject":{"allOf":[{"$ref":"#/components/schemas/ErrorObject"},{"properties":{"code":{"enum":["INVENTORY_TRANSFER_ACTION_NOT_ALLOWED"],"type":"string","x-enum-descriptions":["INVENTORY TRANSFER ACTION NOT ALLOWED."],"x-flint-enum":"closed"},"current_status":{"description":"Current transfer status.","enum":["draft","in_transit","partially_resolved","closed"],"type":"string","x-enum-descriptions":["Draft.","In transit.","Partially resolved.","Closed."],"x-flint-enum":"open"},"current_version":{"description":"Current transfer version.","format":"uint64","minimum":1,"type":"integer"},"details":{"items":{"$ref":"#/components/schemas/InventoryTransferActionConflictErrorDetail"},"minItems":1,"type":"array"},"param":{"enum":["action"],"type":"string","x-enum-descriptions":["Action."],"x-flint-enum":"closed"},"supported_actions":{"description":"Transfer actions accepted in the current state. A closed transfer returns an empty array.","items":{"enum":["depart","receive","return_to_origin","report_loss","cancel"],"type":"string","x-enum-descriptions":["Depart.","Receive.","Return to origin.","Report loss.","Cancel."],"x-flint-enum":"closed"},"type":"array"},"type":{"enum":["conflict_error"],"type":"string","x-enum-descriptions":["Conflict error."],"x-flint-enum":"closed"}},"required":["type","code","message","doc_url","error_source","param","current_status","current_version","supported_actions","details"],"type":"object"}]},"InventoryTransferConflictErrorEnvelope":{"oneOf":[{"$ref":"#/components/schemas/InventoryTransferActionConflictErrorEnvelope"},{"$ref":"#/components/schemas/InventoryTransferOtherConflictErrorEnvelope"}]},"InventoryTransferLine":{"properties":{"canceled_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"departed_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"inventory_item_id":{"type":"string"},"inventory_transfer_line_id":{"type":"string"},"lost_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"physical_condition":{"enum":["sellable","quality_control","damaged","quarantined"],"type":"string","x-enum-descriptions":["Sellable.","Quality control.","Damaged.","Quarantined."],"x-flint-enum":"closed"},"received_damaged_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"received_quality_control_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"received_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"received_quarantined_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"received_sellable_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"requested_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"returned_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"}},"required":["canceled_quantity","departed_quantity","inventory_item_id","inventory_transfer_line_id","lost_quantity","physical_condition","received_damaged_quantity","received_quality_control_quantity","received_quantity","received_quarantined_quantity","received_sellable_quantity","requested_quantity","returned_quantity"],"type":"object"},"InventoryTransferLineInput":{"additionalProperties":false,"properties":{"inventory_item_id":{"type":"string"},"physical_condition":{"default":"sellable","enum":["sellable","quality_control","damaged","quarantined"],"type":"string","x-enum-descriptions":["Sellable.","Quality control.","Damaged.","Quarantined."],"x-flint-enum":"closed"},"requested_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","minimum":1,"type":"integer"}},"required":["inventory_item_id","requested_quantity"],"type":"object"},"InventoryTransferListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InventoryTransfer"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InventoryTransferOtherConflictErrorEnvelope":{"allOf":[{"$ref":"#/components/schemas/ErrorEnvelope"},{"properties":{"error":{"properties":{"code":{"not":{"enum":["INVENTORY_TRANSFER_ACTION_NOT_ALLOWED"],"x-enum-descriptions":["INVENTORY TRANSFER ACTION NOT ALLOWED."],"x-flint-enum":"closed"},"type":"string"}},"type":"object"}},"required":["error"],"type":"object"}]},"InventoryTransferProvenanceInput":{"additionalProperties":false,"properties":{"external_actor_id":{"type":"string"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"source_system":{"$ref":"#/components/schemas/InventorySourceSystemInput"}},"type":"object"},"InventoryTransferResponse":{"properties":{"data":{"$ref":"#/components/schemas/InventoryTransfer"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InventoryTransferResult":{"properties":{"idempotency_key":{"type":"string"},"inventory_movement_ids":{"items":{"type":"string"},"type":"array"},"inventory_transfer":{"$ref":"#/components/schemas/InventoryTransfer"},"resulting_inventory_levels":{"items":{"$ref":"#/components/schemas/InventoryLevel"},"type":"array"}},"required":["idempotency_key","inventory_movement_ids","inventory_transfer","resulting_inventory_levels"],"type":"object"},"InventoryTransferResultResponse":{"properties":{"data":{"$ref":"#/components/schemas/InventoryTransferResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InventoryTransferTransitionRequest":{"discriminator":{"propertyName":"action"},"oneOf":[{"additionalProperties":false,"properties":{"action":{"enum":["depart"],"type":"string","x-enum-descriptions":["Depart."],"x-flint-enum":"closed"},"expected_version":{"description":"Transfer version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"lines":{"items":{"additionalProperties":false,"properties":{"inventory_transfer_line_id":{"description":"Transfer line being transitioned.","type":"string"},"target_departed_quantity":{"description":"Cumulative quantity that should have departed the origin. Whole-number quantity; fractional quantities are not supported.","format":"int64","minimum":0,"type":"integer"}},"required":["inventory_transfer_line_id","target_departed_quantity"],"type":"object"},"maxItems":100,"minItems":1,"type":"array"},"provenance":{"$ref":"#/components/schemas/InventoryTransferProvenanceInput"}},"required":["action","provenance","lines"],"type":"object"},{"additionalProperties":false,"properties":{"action":{"enum":["receive"],"type":"string","x-enum-descriptions":["Receive."],"x-flint-enum":"closed"},"expected_version":{"description":"Transfer version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"lines":{"items":{"additionalProperties":false,"oneOf":[{"not":{"anyOf":[{"required":["target_received_sellable_quantity"]},{"required":["target_received_quality_control_quantity"]},{"required":["target_received_damaged_quantity"]},{"required":["target_received_quarantined_quantity"]}]}},{"required":["target_received_sellable_quantity","target_received_quality_control_quantity","target_received_damaged_quantity","target_received_quarantined_quantity"]}],"properties":{"inventory_transfer_line_id":{"description":"Transfer line being transitioned.","type":"string"},"target_received_damaged_quantity":{"description":"Cumulative received quantity classified as damaged. Whole-number quantity; fractional quantities are not supported.","format":"int64","minimum":0,"type":"integer"},"target_received_quality_control_quantity":{"description":"Cumulative received quantity classified for quality control. Whole-number quantity; fractional quantities are not supported.","format":"int64","minimum":0,"type":"integer"},"target_received_quantity":{"description":"Cumulative quantity that should have been received at the destination. Whole-number quantity; fractional quantities are not supported.","format":"int64","minimum":0,"type":"integer"},"target_received_quarantined_quantity":{"description":"Cumulative received quantity classified as quarantined. Whole-number quantity; fractional quantities are not supported.","format":"int64","minimum":0,"type":"integer"},"target_received_sellable_quantity":{"description":"Cumulative received quantity classified as sellable. Whole-number quantity; fractional quantities are not supported.","format":"int64","minimum":0,"type":"integer"}},"required":["inventory_transfer_line_id","target_received_quantity"],"type":"object"},"maxItems":100,"minItems":1,"type":"array"},"provenance":{"$ref":"#/components/schemas/InventoryTransferProvenanceInput"}},"required":["action","provenance","lines"],"type":"object"},{"additionalProperties":false,"properties":{"action":{"enum":["return_to_origin"],"type":"string","x-enum-descriptions":["Return to origin."],"x-flint-enum":"closed"},"expected_version":{"description":"Transfer version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"lines":{"items":{"additionalProperties":false,"properties":{"inventory_transfer_line_id":{"description":"Transfer line being transitioned.","type":"string"},"target_returned_quantity":{"description":"Cumulative quantity that should have returned to the origin. Whole-number quantity; fractional quantities are not supported.","format":"int64","minimum":0,"type":"integer"}},"required":["inventory_transfer_line_id","target_returned_quantity"],"type":"object"},"maxItems":100,"minItems":1,"type":"array"},"provenance":{"$ref":"#/components/schemas/InventoryTransferProvenanceInput"}},"required":["action","provenance","lines"],"type":"object"},{"additionalProperties":false,"properties":{"action":{"enum":["report_loss"],"type":"string","x-enum-descriptions":["Report loss."],"x-flint-enum":"closed"},"expected_version":{"description":"Transfer version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"lines":{"items":{"additionalProperties":false,"properties":{"inventory_transfer_line_id":{"description":"Transfer line being transitioned.","type":"string"},"target_lost_quantity":{"description":"Cumulative quantity that should be recorded as lost in transit. Whole-number quantity; fractional quantities are not supported.","format":"int64","minimum":0,"type":"integer"}},"required":["inventory_transfer_line_id","target_lost_quantity"],"type":"object"},"maxItems":100,"minItems":1,"type":"array"},"provenance":{"$ref":"#/components/schemas/InventoryTransferProvenanceInput"}},"required":["action","provenance","lines"],"type":"object"},{"additionalProperties":false,"properties":{"action":{"enum":["cancel"],"type":"string","x-enum-descriptions":["Cancel."],"x-flint-enum":"closed"},"expected_version":{"description":"Transfer version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"lines":{"items":{"additionalProperties":false,"properties":{"inventory_transfer_line_id":{"description":"Transfer line being transitioned.","type":"string"},"target_canceled_quantity":{"description":"Cumulative quantity that should be canceled before departure. Whole-number quantity; fractional quantities are not supported.","format":"int64","minimum":0,"type":"integer"}},"required":["inventory_transfer_line_id","target_canceled_quantity"],"type":"object"},"maxItems":100,"minItems":1,"type":"array"},"provenance":{"$ref":"#/components/schemas/InventoryTransferProvenanceInput"}},"required":["action","provenance","lines"],"type":"object"}]},"Invoice":{"properties":{"cc_emails":{"items":{"type":"string"},"type":"array"},"closed_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"collection_block_status":{"enum":["none","inventory_blocked","resolved"],"readOnly":true,"type":"string","x-enum-descriptions":["None.","Inventory blocked.","Resolved."],"x-flint-enum":"open"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"readOnly":true,"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"credit_money":{"$ref":"#/components/schemas/Money","readOnly":true},"currently_due_money":{"$ref":"#/components/schemas/Money","readOnly":true},"customer":{"anyOf":[{"$ref":"#/components/schemas/ExpandedCustomerSummary"},{"type":"null"}],"readOnly":true},"customer_id":{"readOnly":true,"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"readOnly":true,"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"due_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"footer":{"type":"string"},"invoice_id":{"readOnly":true,"type":"string"},"invoice_number":{"description":"Sequential document number assigned when the invoice is issued. Numbering is per merchant, with test and live mode numbered independently.","readOnly":true,"type":"string"},"is_overdue":{"readOnly":true,"type":"boolean"},"issued_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"late_fees":{"items":{"$ref":"#/components/schemas/InvoiceLateFee"},"readOnly":true,"type":"array"},"memo":{"type":"string"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrderSummary"},{"type":"null"}],"readOnly":true},"order_id":{"readOnly":true,"type":"string"},"outstanding_money":{"$ref":"#/components/schemas/Money","readOnly":true},"paid_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"paid_money":{"$ref":"#/components/schemas/Money","readOnly":true},"payment_method_id":{"readOnly":true,"type":"string"},"payment_policy":{"$ref":"#/components/schemas/InvoicePaymentPolicy","readOnly":true},"payment_terms_snapshot":{"$ref":"#/components/schemas/InvoicePaymentTermsSnapshot","readOnly":true},"po_number":{"readOnly":true,"type":"string"},"public_url":{"readOnly":true,"type":"string"},"recipient_email":{"type":"string"},"reference":{"type":"string"},"refund_status":{"enum":["none","partially_refunded","refunded"],"readOnly":true,"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"refunded_money":{"$ref":"#/components/schemas/Money","readOnly":true},"reminders_paused_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"remit_to_address":{"$ref":"#/components/schemas/Address","readOnly":true},"schedule_entries":{"items":{"$ref":"#/components/schemas/InvoiceScheduleEntry"},"readOnly":true,"type":"array"},"scheduled_send_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"service_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"snapshot":{"$ref":"#/components/schemas/InvoiceSnapshot","readOnly":true},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"readOnly":true,"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"timezone":{"readOnly":true,"type":"string"},"uncollectible_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"version":{"description":"Current invoice version. Send this as expected_version when updating the draft.","format":"int64","minimum":1,"readOnly":true,"type":"integer"},"viewed_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"voided_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"written_off_money":{"$ref":"#/components/schemas/Money","readOnly":true}},"required":["collection_block_status","credit_money","currently_due_money","invoice_id","is_overdue","late_fees","merchant_id","order_id","outstanding_money","paid_money","refund_status","refunded_money","status","version"],"type":"object"},"InvoiceAutopayRetryPolicy":{"additionalProperties":false,"properties":{"retry_day_offsets":{"items":{"format":"int32","maximum":30,"minimum":1,"type":"integer"},"maxItems":5,"type":"array","uniqueItems":true}},"required":["retry_day_offsets"],"type":"object"},"InvoiceCheckoutSessionResponse":{"properties":{"data":{"$ref":"#/components/schemas/InvoiceCheckoutSessionResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InvoiceCheckoutSessionResult":{"properties":{"checkout_session":{"$ref":"#/components/schemas/CheckoutSession"},"hosted_checkout":{"$ref":"#/components/schemas/HostedCheckout"},"invoice":{"$ref":"#/components/schemas/Invoice"},"invoice_payment_attempt":{"$ref":"#/components/schemas/InvoicePaymentAttempt"},"reused_existing":{"type":"boolean"}},"required":["checkout_session","hosted_checkout","invoice","reused_existing"],"type":"object"},"InvoiceCollectionInput":{"additionalProperties":false,"discriminator":{"propertyName":"mode"},"oneOf":[{"not":{"anyOf":[{"required":["payment_method_id"]},{"required":["payment_policy"]}]},"properties":{"mode":{"enum":["merchant_default"],"type":"string","x-enum-descriptions":["Merchant default."],"x-flint-enum":"closed"}}},{"not":{"anyOf":[{"required":["payment_method_id"]}]},"properties":{"mode":{"enum":["buyer_initiated"],"type":"string","x-enum-descriptions":["Buyer initiated."],"x-flint-enum":"closed"}}},{"not":{"anyOf":[{"required":["payment_policy"]}]},"properties":{"mode":{"enum":["automatic"],"type":"string","x-enum-descriptions":["Automatic."],"x-flint-enum":"closed"}}},{"not":{"anyOf":[{"required":["payment_method_id"]},{"required":["payment_policy"]}]},"properties":{"mode":{"enum":["external"],"type":"string","x-enum-descriptions":["External."],"x-flint-enum":"closed"}}}],"properties":{"mode":{"enum":["merchant_default","buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Merchant default.","Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"payment_method_id":{"type":"string"},"payment_policy":{"$ref":"#/components/schemas/InvoicePaymentPolicy"}},"required":["mode"],"type":"object"},"InvoiceDeliveryAttempt":{"properties":{"cc_emails":{"items":{"type":"string"},"type":"array"},"channel":{"enum":["email"],"type":"string","x-enum-descriptions":["Email."],"x-flint-enum":"closed"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"delivery_type":{"enum":["send","reminder"],"type":"string","x-enum-descriptions":["Send.","Reminder."],"x-flint-enum":"closed"},"error_message":{"type":"string"},"invoice_delivery_attempt_id":{"type":"string"},"sent_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"status":{"enum":["pending","sent","failed","suppressed"],"type":"string","x-enum-descriptions":["Pending.","Sent.","Failed.","Suppressed."],"x-flint-enum":"open"},"to_email":{"type":"string"}},"required":["channel","delivery_type","invoice_delivery_attempt_id","status","to_email"],"type":"object"},"InvoiceDeliveryAttemptListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InvoiceDeliveryAttempt"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InvoiceDiscount":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"applied_money":{"$ref":"#/components/schemas/Money"},"customer_facing_name":{"type":"string"},"discount_class":{"enum":["order","line_item","service_charge"],"type":"string","x-enum-descriptions":["Order.","Line item.","Service charge."],"x-flint-enum":"closed"},"promotion_code":{"type":"string"},"promotion_id":{"type":"string"},"source":{"enum":["manual","promotion"],"type":"string","x-enum-descriptions":["Manual.","Promotion."],"x-flint-enum":"closed"}},"required":["amount_money","applied_money","source"],"type":"object"},"InvoiceEvent":{"properties":{"actor_id":{"type":"string"},"actor_type":{"type":"string"},"description":{"type":"string"},"event_type":{"description":"Flint-normalized invoice event type. Unmapped internal values are returned as updated.","enum":["draft_created","issued","sent","delivery_sent","reminder_sent","viewed","payment_applied","manual_payment_recorded","manual_payment_reversed","refund_succeeded","voided","token_regenerated","collection_blocked","collection_block_resolved","updated","marked_uncollectible","payment_processing","issue_failed","overdue","reminder_due","late_fee_due","late_fee_assessed","late_fee_waived","credited"],"type":"string","x-enum-descriptions":["Draft created.","Issued.","Sent.","Delivery sent.","Reminder sent.","Viewed.","Payment applied.","Manual payment recorded.","Manual payment reversed.","Refund succeeded.","Voided.","Token regenerated.","Collection blocked.","Collection block resolved.","Updated.","Marked uncollectible.","Payment processing.","Issue failed.","Overdue.","Reminder due.","Late fee due.","Late fee assessed.","Late fee waived.","Credited."],"x-flint-enum":"closed"},"invoice_event_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["description","event_type","invoice_event_id"],"type":"object"},"InvoiceEventListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InvoiceEvent"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InvoiceLateFee":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"assessed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"base_outstanding_money":{"$ref":"#/components/schemas/Money"},"invoice_late_fee_id":{"type":"string"},"invoice_schedule_entry_id":{"type":"string"},"late_fee_policy":{"$ref":"#/components/schemas/InvoiceLateFeePolicy"},"outstanding_money":{"$ref":"#/components/schemas/Money"},"paid_money":{"$ref":"#/components/schemas/Money"},"waived_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"waived_money":{"$ref":"#/components/schemas/Money"},"waiver_reason":{"type":"string"},"written_off_money":{"$ref":"#/components/schemas/Money"}},"required":["amount_money","assessed_at","base_outstanding_money","invoice_late_fee_id","outstanding_money","paid_money","waived_money","written_off_money"],"type":"object"},"InvoiceLateFeePolicy":{"additionalProperties":false,"discriminator":{"propertyName":"type"},"oneOf":[{"not":{"required":["percent"]},"properties":{"type":{"enum":["fixed"],"type":"string","x-enum-descriptions":["Fixed."],"x-flint-enum":"closed"}},"required":["type","grace_period_days","amount_money"]},{"not":{"required":["amount_money"]},"properties":{"type":{"enum":["percentage"],"type":"string","x-enum-descriptions":["Percentage."],"x-flint-enum":"closed"}},"required":["type","grace_period_days","percent"]}],"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"application_mode":{"default":"manual","description":"Whether Flint applies the one-time fee automatically after the grace period. Omission defaults to manual. Frozen when the invoice is issued.","enum":["manual","automatic"],"type":"string","x-enum-descriptions":["Manual.","Automatic."],"x-flint-enum":"closed"},"grace_period_days":{"format":"int32","type":"integer"},"percent":{"multipleOf":0.0001,"type":"number"},"type":{"enum":["fixed","percentage"],"type":"string","x-enum-descriptions":["Fixed.","Percentage."],"x-flint-enum":"closed"}},"required":["grace_period_days","type"],"type":"object"},"InvoiceLineItem":{"properties":{"base_subtotal_money":{"$ref":"#/components/schemas/Money"},"bundle_components":{"items":{"$ref":"#/components/schemas/BundleComponent"},"type":"array"},"bundle_id":{"type":"string"},"categories":{"items":{"$ref":"#/components/schemas/CategoryReference"},"type":"array"},"description":{"type":"string"},"discount_money":{"$ref":"#/components/schemas/Money"},"image":{"$ref":"#/components/schemas/Image"},"invoice_line_item_id":{"type":"string"},"modifier_total_money":{"$ref":"#/components/schemas/Money"},"modifiers":{"items":{"$ref":"#/components/schemas/OrderLineItemModifier"},"type":"array"},"name":{"type":"string"},"order_line_item_id":{"type":"string"},"product_id":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"selected_options":{"items":{"$ref":"#/components/schemas/SelectedProductOption"},"type":"array"},"sku":{"type":"string"},"source_type":{"enum":["variant","bundle"],"type":"string","x-enum-descriptions":["Variant.","Bundle."],"x-flint-enum":"closed"},"subtotal_money":{"$ref":"#/components/schemas/Money"},"tax_money":{"$ref":"#/components/schemas/Money"},"total_money":{"$ref":"#/components/schemas/SignedMoney"},"unit_price_money":{"$ref":"#/components/schemas/Money"},"variant_id":{"type":"string"}},"required":["base_subtotal_money","discount_money","invoice_line_item_id","modifier_total_money","name","quantity","subtotal_money","tax_money","total_money","unit_price_money"],"type":"object"},"InvoiceListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Invoice"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InvoiceManualPaymentRequest":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"expected_version":{"format":"int64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"note":{"type":"string"},"received_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["amount_money"],"type":"object"},"InvoicePaymentAttempt":{"properties":{"canceled_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"cancellation_requested_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"checkout_session_id":{"type":"string"},"expected_amount_money":{"$ref":"#/components/schemas/Money"},"expected_settlement_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"failure_code":{"description":"Flint-normalized invoice payment attempt failure code. Unknown provider values are returned as payment_failed.","enum":["card_declined","insufficient_funds","bank_account_closed","bank_account_not_found","bank_debit_not_authorized","bank_account_restricted","bank_debit_limit_exceeded","authentication_required","payment_blocked","expired_card","incorrect_cvc","processing_error","payment_method_unavailable","payment_method_declined","payment_not_completed","payment_action_expired","payment_method_temporarily_unavailable","payment_failed"],"type":"string","x-enum-descriptions":["Card declined.","Insufficient funds.","Bank account closed.","Bank account not found.","Bank debit not authorized.","Bank account restricted.","Bank debit limit exceeded.","Authentication required.","Payment blocked.","Expired card.","Incorrect cvc.","Processing error.","Payment method unavailable.","Payment method declined.","Payment not completed.","Payment action expired.","Payment method temporarily unavailable.","Payment failed."],"x-flint-enum":"closed"},"failure_message":{"description":"Flint-authored invoice payment attempt failure message. This is stable explanatory text, not a raw provider message.","type":"string"},"invoice_id":{"type":"string"},"invoice_payment_attempt_id":{"type":"string"},"invoice_schedule_entry_id":{"type":"string"},"payment_intent_id":{"type":"string"},"rail":{"enum":["card","ach_debit","manual"],"type":"string","x-enum-descriptions":["Card.","Ach debit.","Manual."],"x-flint-enum":"closed"},"settled_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"started_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"status":{"enum":["open","settled","failed","canceled","expired","processing"],"type":"string","x-enum-descriptions":["Open.","Settled.","Failed.","Canceled.","Expired.","Processing."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["expected_amount_money","invoice_id","invoice_payment_attempt_id","rail","status"],"type":"object"},"InvoicePaymentAttemptListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InvoicePaymentAttempt"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InvoicePaymentAttemptResponse":{"properties":{"data":{"$ref":"#/components/schemas/InvoicePaymentAttempt"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InvoicePaymentDueInput":{"additionalProperties":false,"discriminator":{"propertyName":"type"},"oneOf":[{"not":{"anyOf":[{"required":["due_at"]},{"required":["invoice_payment_term_id"]}]},"properties":{"type":{"enum":["none"],"type":"string","x-enum-descriptions":["None."],"x-flint-enum":"closed"}}},{"not":{"required":["invoice_payment_term_id"]},"properties":{"type":{"enum":["absolute"],"type":"string","x-enum-descriptions":["Absolute."],"x-flint-enum":"closed"}},"required":["due_at"]},{"not":{"required":["due_at"]},"properties":{"type":{"enum":["payment_terms"],"type":"string","x-enum-descriptions":["Payment terms."],"x-flint-enum":"closed"}},"required":["invoice_payment_term_id"]},{"not":{"anyOf":[{"required":["due_at"]},{"required":["invoice_payment_term_id"]}]},"properties":{"type":{"enum":["customer_default"],"type":"string","x-enum-descriptions":["Customer default."],"x-flint-enum":"closed"}}},{"not":{"anyOf":[{"required":["due_at"]},{"required":["invoice_payment_term_id"]}]},"properties":{"type":{"enum":["merchant_default"],"type":"string","x-enum-descriptions":["Merchant default."],"x-flint-enum":"closed"}}}],"properties":{"due_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"invoice_payment_term_id":{"type":"string"},"type":{"enum":["none","absolute","payment_terms","customer_default","merchant_default"],"type":"string","x-enum-descriptions":["None.","Absolute.","Payment terms.","Customer default.","Merchant default."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"InvoicePaymentOptionLimit":{"additionalProperties":false,"properties":{"max_total_money":{"$ref":"#/components/schemas/Money"},"payment_option":{"enum":["card","apple_pay","google_pay","affirm","ach_debit"],"type":"string","x-enum-descriptions":["Card.","Apple pay.","Google pay.","Affirm.","Ach debit."],"x-flint-enum":"closed"}},"required":["max_total_money","payment_option"],"type":"object"},"InvoicePaymentPolicy":{"additionalProperties":false,"properties":{"enabled_payment_options":{"items":{"enum":["card","apple_pay","google_pay","affirm","ach_debit"],"type":"string","x-enum-descriptions":["Card.","Apple pay.","Google pay.","Affirm.","Ach debit."],"x-flint-enum":"closed"},"maxItems":5,"type":"array","uniqueItems":true},"payment_option_limits":{"items":{"$ref":"#/components/schemas/InvoicePaymentOptionLimit"},"maxItems":100,"type":"array"},"show_cost_comparison":{"type":"boolean"}},"required":["enabled_payment_options"],"type":"object"},"InvoicePaymentTerm":{"properties":{"calculation":{"$ref":"#/components/schemas/InvoicePaymentTermCalculation","readOnly":true},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"invoice_payment_term_id":{"readOnly":true,"type":"string"},"late_fee_policy":{"$ref":"#/components/schemas/InvoiceLateFeePolicy","readOnly":true},"merchant_id":{"readOnly":true,"type":"string"},"name":{"readOnly":true,"type":"string"},"status":{"enum":["active","archived"],"readOnly":true,"type":"string","x-enum-descriptions":["Active.","Archived."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"version":{"format":"int32","readOnly":true,"type":"integer"}},"required":["calculation","created_at","invoice_payment_term_id","merchant_id","name","status","updated_at","version"],"type":"object"},"InvoicePaymentTermCalculation":{"additionalProperties":false,"discriminator":{"propertyName":"type"},"oneOf":[{"not":{"anyOf":[{"required":["days"]},{"required":["day"]}]},"properties":{"type":{"enum":["on_receipt"],"type":"string","x-enum-descriptions":["On receipt."],"x-flint-enum":"closed"}},"required":["type"]},{"not":{"required":["day"]},"properties":{"type":{"enum":["net_days"],"type":"string","x-enum-descriptions":["Net days."],"x-flint-enum":"closed"}},"required":["type","days"]},{"not":{"required":["day"]},"properties":{"type":{"enum":["days_after_month_end"],"type":"string","x-enum-descriptions":["Days after month end."],"x-flint-enum":"closed"}},"required":["type","days"]},{"not":{"required":["days"]},"properties":{"type":{"enum":["day_of_month"],"type":"string","x-enum-descriptions":["Day of month."],"x-flint-enum":"closed"}},"required":["type","day"]},{"not":{"required":["days"]},"properties":{"type":{"enum":["day_of_next_month"],"type":"string","x-enum-descriptions":["Day of next month."],"x-flint-enum":"closed"}},"required":["type","day"]}],"properties":{"day":{"format":"int32","type":"integer"},"days":{"format":"int32","type":"integer"},"type":{"enum":["on_receipt","net_days","day_of_month","day_of_next_month","days_after_month_end"],"type":"string","x-enum-descriptions":["On receipt.","Net days.","Day of month.","Day of next month.","Days after month end."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"InvoicePaymentTermListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/InvoicePaymentTerm"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InvoicePaymentTermResponse":{"properties":{"data":{"$ref":"#/components/schemas/InvoicePaymentTerm"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InvoicePaymentTermsSnapshot":{"properties":{"calculation":{"$ref":"#/components/schemas/InvoicePaymentTermCalculation"},"invoice_payment_term_id":{"type":"string"},"late_fee_policy":{"$ref":"#/components/schemas/InvoiceLateFeePolicy"},"name":{"type":"string"},"revision":{"format":"int32","type":"integer"}},"required":["calculation","invoice_payment_term_id","name","revision"],"type":"object"},"InvoiceReminderPolicy":{"additionalProperties":false,"properties":{"rules":{"items":{"$ref":"#/components/schemas/InvoiceReminderRule"},"maxItems":20,"type":"array"}},"required":["rules"],"type":"object"},"InvoiceReminderRule":{"additionalProperties":false,"properties":{"days_from_due":{"format":"int32","maximum":365,"minimum":-90,"type":"integer"}},"required":["days_from_due"],"type":"object"},"InvoiceResponse":{"properties":{"data":{"$ref":"#/components/schemas/Invoice"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"InvoiceScheduleAmountSpecification":{"additionalProperties":false,"discriminator":{"propertyName":"type"},"oneOf":[{"not":{"required":["percent"]},"properties":{"type":{"enum":["fixed"],"type":"string","x-enum-descriptions":["Fixed."],"x-flint-enum":"closed"}},"required":["type","amount_money"]},{"not":{"required":["amount_money"]},"properties":{"type":{"enum":["percentage"],"type":"string","x-enum-descriptions":["Percentage."],"x-flint-enum":"closed"}},"required":["type","percent"]},{"not":{"anyOf":[{"required":["amount_money"]},{"required":["percent"]}]},"properties":{"type":{"enum":["remaining_balance"],"type":"string","x-enum-descriptions":["Remaining balance."],"x-flint-enum":"closed"}},"required":["type"]}],"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"percent":{"multipleOf":0.0001,"type":"number"},"type":{"enum":["fixed","percentage","remaining_balance"],"type":"string","x-enum-descriptions":["Fixed.","Percentage.","Remaining balance."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"InvoiceScheduleDue":{"additionalProperties":false,"discriminator":{"propertyName":"type"},"oneOf":[{"not":{"required":["due_at"]},"properties":{"type":{"enum":["at_issue"],"type":"string","x-enum-descriptions":["At issue."],"x-flint-enum":"closed"}},"required":["type"]},{"properties":{"type":{"enum":["date"],"type":"string","x-enum-descriptions":["Date."],"x-flint-enum":"closed"}},"required":["type","due_at"]},{"not":{"required":["due_at"]},"properties":{"type":{"enum":["invoice_due_date"],"type":"string","x-enum-descriptions":["Invoice due date."],"x-flint-enum":"closed"}},"required":["type"]}],"properties":{"due_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"type":{"enum":["at_issue","date","invoice_due_date"],"type":"string","x-enum-descriptions":["At issue.","Date.","Invoice due date."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"InvoiceScheduleEntry":{"properties":{"amount_specification":{"$ref":"#/components/schemas/InvoiceScheduleAmountSpecification"},"credit_money":{"$ref":"#/components/schemas/Money","readOnly":true},"due":{"$ref":"#/components/schemas/InvoiceScheduleDue"},"invoice_schedule_entry_id":{"readOnly":true,"type":"string"},"kind":{"enum":["deposit","installment","balance"],"type":"string","x-enum-descriptions":["Deposit.","Installment.","Balance."],"x-flint-enum":"closed"},"outstanding_money":{"$ref":"#/components/schemas/Money","readOnly":true},"paid_money":{"$ref":"#/components/schemas/Money","readOnly":true},"status":{"enum":["pending","due","partially_satisfied","satisfied","overdue"],"type":"string","x-enum-descriptions":["Pending.","Due.","Partially satisfied.","Satisfied.","Overdue."],"x-flint-enum":"open"},"total_money":{"$ref":"#/components/schemas/Money","readOnly":true},"written_off_money":{"$ref":"#/components/schemas/Money","readOnly":true}},"required":["amount_specification","credit_money","due","invoice_schedule_entry_id","kind","outstanding_money","paid_money","status","total_money","written_off_money"],"type":"object"},"InvoiceScheduleEntryWrite":{"additionalProperties":false,"discriminator":{"propertyName":"kind"},"oneOf":[{"properties":{"amount_specification":{"allOf":[{"$ref":"#/components/schemas/InvoiceScheduleAmountSpecification"},{"properties":{"type":{"enum":["fixed","percentage"],"type":"string","x-enum-descriptions":["Fixed.","Percentage."],"x-flint-enum":"closed"}}}]},"due":{"allOf":[{"$ref":"#/components/schemas/InvoiceScheduleDue"},{"properties":{"type":{"enum":["at_issue","date"],"type":"string","x-enum-descriptions":["At issue.","Date."],"x-flint-enum":"closed"}}}]},"kind":{"enum":["deposit"],"type":"string","x-enum-descriptions":["Deposit."],"x-flint-enum":"closed"}}},{"properties":{"amount_specification":{"allOf":[{"$ref":"#/components/schemas/InvoiceScheduleAmountSpecification"},{"properties":{"type":{"enum":["fixed","percentage"],"type":"string","x-enum-descriptions":["Fixed.","Percentage."],"x-flint-enum":"closed"}}}]},"due":{"allOf":[{"$ref":"#/components/schemas/InvoiceScheduleDue"},{"properties":{"type":{"enum":["date"],"type":"string","x-enum-descriptions":["Date."],"x-flint-enum":"closed"}}}]},"kind":{"enum":["installment"],"type":"string","x-enum-descriptions":["Installment."],"x-flint-enum":"closed"}}},{"properties":{"amount_specification":{"allOf":[{"$ref":"#/components/schemas/InvoiceScheduleAmountSpecification"},{"properties":{"type":{"enum":["remaining_balance"],"type":"string","x-enum-descriptions":["Remaining balance."],"x-flint-enum":"closed"}}}]},"due":{"allOf":[{"$ref":"#/components/schemas/InvoiceScheduleDue"},{"properties":{"type":{"enum":["invoice_due_date","date"],"type":"string","x-enum-descriptions":["Invoice due date.","Date."],"x-flint-enum":"closed"}}}]},"kind":{"enum":["balance"],"type":"string","x-enum-descriptions":["Balance."],"x-flint-enum":"closed"}}}],"properties":{"amount_specification":{"$ref":"#/components/schemas/InvoiceScheduleAmountSpecification"},"due":{"$ref":"#/components/schemas/InvoiceScheduleDue"},"invoice_schedule_entry_id":{"type":"string"},"kind":{"enum":["deposit","installment","balance"],"type":"string","x-enum-descriptions":["Deposit.","Installment.","Balance."],"x-flint-enum":"closed"}},"required":["amount_specification","due","kind"],"type":"object"},"InvoiceSettings":{"additionalProperties":false,"properties":{"autopay_retry_policy":{"$ref":"#/components/schemas/InvoiceAutopayRetryPolicy"},"credit_note_number_prefix":{"maxLength":12,"pattern":"^[A-Za-z0-9_-]*$","type":"string"},"default_collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"default_footer":{"maxLength":4096,"type":"string"},"default_invoice_payment_term_id":{"pattern":"^ipt_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"default_memo":{"maxLength":4096,"type":"string"},"invoice_number_prefix":{"maxLength":12,"pattern":"^[A-Za-z0-9_-]*$","type":"string"},"payment_policy":{"$ref":"#/components/schemas/InvoicePaymentPolicy"},"reminder_policy":{"$ref":"#/components/schemas/InvoiceReminderPolicy"},"remit_to_address":{"$ref":"#/components/schemas/Address"},"reply_to_email":{"format":"email","maxLength":255,"type":"string"},"timezone":{"maxLength":255,"type":"string"}},"type":"object"},"InvoiceSettingsPatch":{"additionalProperties":false,"minProperties":1,"properties":{"autopay_retry_policy":{"anyOf":[{"$ref":"#/components/schemas/InvoiceAutopayRetryPolicy"},{"type":"null"}]},"credit_note_number_prefix":{"maxLength":12,"pattern":"^[A-Za-z0-9_-]*$","type":["string","null"]},"default_collection_mode":{"enum":["buyer_initiated","automatic","external",null],"type":["string","null"],"x-enum-descriptions":["Buyer initiated.","Automatic.","External.","Null."],"x-flint-enum":"closed"},"default_footer":{"maxLength":4096,"type":["string","null"]},"default_invoice_payment_term_id":{"pattern":"^ipt_[0-9A-HJKMNP-TV-Z]{26}$","type":["string","null"]},"default_memo":{"maxLength":4096,"type":["string","null"]},"invoice_number_prefix":{"maxLength":12,"pattern":"^[A-Za-z0-9_-]*$","type":["string","null"]},"payment_policy":{"anyOf":[{"$ref":"#/components/schemas/InvoicePaymentPolicy"},{"type":"null"}]},"reminder_policy":{"anyOf":[{"$ref":"#/components/schemas/InvoiceReminderPolicy"},{"type":"null"}]},"remit_to_address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"reply_to_email":{"format":"email","maxLength":255,"type":["string","null"]},"timezone":{"maxLength":255,"type":["string","null"]}},"type":"object"},"InvoiceSnapshot":{"properties":{"billing_address":{"$ref":"#/components/schemas/Address"},"buyer_note":{"type":"string"},"buyer_tax_identity":{"anyOf":[{"$ref":"#/components/schemas/TaxIdentity"},{"type":"null"}],"description":"Identity frozen on the source invoice at issue. Later profile edits do not change this document.","readOnly":true},"charges":{"items":{"$ref":"#/components/schemas/OrderCharge"},"type":"array"},"customer_display_name":{"type":"string"},"customer_email":{"type":"string"},"discounts":{"items":{"$ref":"#/components/schemas/InvoiceDiscount"},"type":"array"},"footer":{"type":"string"},"internal_note":{"type":"string"},"line_items":{"items":{"$ref":"#/components/schemas/InvoiceLineItem"},"type":"array"},"memo":{"type":"string"},"merchant_display_name":{"type":"string"},"pricing_amounts":{"$ref":"#/components/schemas/PricingAmounts"},"reference":{"type":"string"},"requested_tip":{"$ref":"#/components/schemas/InvoiceTip"},"seller_tax_identity":{"anyOf":[{"$ref":"#/components/schemas/TaxIdentity"},{"type":"null"}],"description":"Identity frozen on the source invoice at issue. Later profile edits do not change this document.","readOnly":true},"service_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["pricing_amounts"],"type":"object"},"InvoiceTip":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"description":{"type":"string"},"name":{"type":"string"},"percent":{"multipleOf":0.0001,"type":"number"}},"type":"object"},"IssueCreditNoteRequest":{"properties":{"expected_version":{"format":"int64","minimum":1,"type":"integer"},"refund":{"$ref":"#/components/schemas/CreditNoteRefundInput"}},"type":"object"},"IssueCreditNoteResponse":{"properties":{"data":{"$ref":"#/components/schemas/IssuedCreditNote"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"IssueInvoiceRequest":{"properties":{"delivery_mode":{"default":"merchant_default","enum":["merchant_default","email","caller_managed"],"type":"string","x-enum-descriptions":["Merchant default.","Email.","Caller managed."],"x-flint-enum":"closed"},"expected_version":{"format":"int64","minimum":1,"type":"integer"}},"type":"object"},"IssueInvoiceResponse":{"properties":{"data":{"$ref":"#/components/schemas/IssueInvoiceResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"IssueInvoiceResult":{"properties":{"delivery_attempt":{"$ref":"#/components/schemas/InvoiceDeliveryAttempt"},"invoice":{"$ref":"#/components/schemas/Invoice"},"public_url":{"type":"string"}},"required":["invoice"],"type":"object"},"IssueSandboxAPIKeyRequest":{"properties":{"name":{"type":"string"},"scopes":{"items":{"type":"string"},"type":"array"}},"required":["name"],"type":"object"},"IssuedCreditNote":{"properties":{"buyer_tax_identity":{"$ref":"#/components/schemas/TaxIdentity"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"credit_note_id":{"type":"string"},"credit_note_lines":{"items":{"$ref":"#/components/schemas/CreditNoteLine"},"type":"array"},"credit_note_number":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"invoice_id":{"type":"string"},"issued_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"latest_refund_status":{"enum":["pending","in_transit","succeeded","failed","requires_action","canceled","partially_succeeded"],"type":"string","x-enum-descriptions":["Pending.","In transit.","Succeeded.","Failed.","Requires action.","Canceled.","Partially succeeded."],"x-flint-enum":"open"},"memo":{"type":"string"},"merchant_id":{"type":"string"},"pending_refund_money":{"$ref":"#/components/schemas/Money"},"reason":{"enum":["returned_goods","order_adjustment","billing_error","goodwill","other"],"type":"string","x-enum-descriptions":["Returned goods.","Order adjustment.","Billing error.","Goodwill.","Other."],"x-flint-enum":"closed"},"refund":{"$ref":"#/components/schemas/Refund"},"refunded_money":{"$ref":"#/components/schemas/Money"},"seller_tax_identity":{"$ref":"#/components/schemas/TaxIdentity"},"status":{"enum":["draft","issued","void"],"type":"string","x-enum-descriptions":["Draft.","Issued.","Void."],"x-flint-enum":"open"},"total_money":{"$ref":"#/components/schemas/Money"},"unallocated_money":{"$ref":"#/components/schemas/Money"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"version":{"description":"Current credit note version. Send this as expected_version when updating the draft.","format":"int64","minimum":1,"readOnly":true,"type":"integer"},"voided_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["created_at","credit_note_id","credit_note_lines","invoice_id","merchant_id","pending_refund_money","reason","refunded_money","status","total_money","unallocated_money","updated_at","version"],"type":"object"},"LegalSettings":{"properties":{"contract_url":{"type":"string"},"refund_policy_url":{"type":"string"},"require_terms_of_service":{"type":"boolean"},"shipping_policy_url":{"type":"string"},"terms_of_service_url":{"type":"string"}},"type":"object"},"LineItemFulfillmentInput":{"additionalProperties":false,"properties":{"allowed_types":{"items":{"type":"string"},"type":"array"},"combination_policy":{"enum":["combine_when_compatible","separate_profile","separate_line_item","fulfill_alone"],"type":"string","x-enum-descriptions":["Combine when compatible.","Separate profile.","Separate line item.","Fulfill alone."],"x-flint-enum":"closed"},"dimensions":{"$ref":"#/components/schemas/LineItemFulfillmentSizeInput"},"origin_policy":{"$ref":"#/components/schemas/LineItemFulfillmentOriginInput"},"requirement":{"enum":["none","required"],"type":"string","x-enum-descriptions":["None.","Required."],"x-flint-enum":"closed"},"resolution_mode":{"enum":["quote","manual"],"type":"string","x-enum-descriptions":["Quote.","Manual."],"x-flint-enum":"closed"},"splitting_policy":{"enum":["whole_line_item","quantity_split_allowed"],"type":"string","x-enum-descriptions":["Whole line item.","Quantity split allowed."],"x-flint-enum":"closed"},"weight":{"$ref":"#/components/schemas/LineItemFulfillmentWeightInput"}},"required":["requirement"],"type":"object"},"LineItemFulfillmentOriginInput":{"additionalProperties":false,"properties":{"location_id":{"type":"string"},"origin_policy_type":{"enum":["fixed_location","inventory_routing","method_origin"],"type":"string","x-enum-descriptions":["Fixed location.","Inventory routing.","Method origin."],"x-flint-enum":"closed"}},"required":["origin_policy_type"],"type":"object"},"LineItemFulfillmentSizeInput":{"additionalProperties":false,"properties":{"height":{"format":"int64","type":"integer"},"length":{"format":"int64","type":"integer"},"unit":{"type":"string"},"width":{"format":"int64","type":"integer"}},"required":["height","length","unit","width"],"type":"object"},"LineItemFulfillmentWeightInput":{"additionalProperties":false,"properties":{"unit":{"enum":["gram","kilogram","ounce","pound"],"type":"string","x-enum-descriptions":["Gram.","Kilogram.","Ounce.","Pound."],"x-flint-enum":"closed"},"value":{"format":"int64","type":"integer"}},"required":["unit","value"],"type":"object"},"LineItemInventoryDemand":{"properties":{"bundle_component_id":{"type":"string"},"component_snapshot_id":{"type":"string"},"inventory_item_id":{"type":"string"},"quantity_per_line_item_unit":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"}},"required":["inventory_item_id","quantity_per_line_item_unit"],"type":"object"},"LineItemInventorySnapshot":{"properties":{"demands":{"items":{"$ref":"#/components/schemas/LineItemInventoryDemand"},"type":"array"},"inventory_tracking":{"enum":["not_tracked","tracked"],"type":"string","x-enum-descriptions":["Not tracked.","Tracked."],"x-flint-enum":"closed"}},"required":["demands","inventory_tracking"],"type":"object"},"ListReturnDispositionsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ReturnDisposition"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ListReturnInspectionsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ReturnInspection"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ListReturnLineItemsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ReturnLineItem"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ListReturnPoliciesResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ReturnPolicy"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ListReturnPolicyRevisionsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ReturnPolicyRevision"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ListReturnReasonsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ReturnReason"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ListReturnReceiptsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ReturnReceipt"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ListReturnResolutionsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ReturnResolution"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ListReturnsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Return"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"Location":{"description":"A physical or logical place a merchant operates from. Locations own geography and, when inventory is enabled, an inventory capability block.","properties":{"address":{"$ref":"#/components/schemas/LocationAddress","description":"Published postal address."},"coordinate":{"$ref":"#/components/schemas/LocationCoordinate","description":"Published geographic coordinate."},"coordinate_source":{"description":"Source of the stored latitude and longitude.","enum":["merchant_supplied","geocoded",null],"type":["string","null"],"x-enum-descriptions":["Merchant supplied.","Geocoded.","Null."],"x-flint-enum":"closed"},"created_at":{"description":"Time the Location was created.","format":"date-time","type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"geography_revision":{"description":"Optimistic-concurrency revision for geography writes.","format":"uint64","minimum":0,"type":"integer"},"inventory":{"$ref":"#/components/schemas/LocationInventory","description":"Inventory allocation capability at this Location."},"location_id":{"description":"Stable Location ID.","type":"string"},"metadata":{"additionalProperties":{"type":"string"},"description":"Caller-owned metadata.","type":"object"},"name":{"description":"Merchant-facing Location name.","type":"string"},"normalized_address":{"$ref":"#/components/schemas/LocationAddress","description":"Provider-normalized address used for geography evaluation."},"status":{"description":"Current Location lifecycle status.","enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"},"timezone":{"description":"IANA timezone for local schedules.","type":"string"},"updated_at":{"description":"Time the Location last changed.","format":"date-time","type":"string"},"validation_failure_reason":{"description":"Normalized reason address validation failed.","type":"string"},"validation_status":{"description":"Address validation status.","enum":["not_validated","validated","merchant_verified"],"type":"string","x-enum-descriptions":["Not validated.","Validated.","Merchant verified."],"x-flint-enum":"open"},"version":{"description":"Optimistic-concurrency version for general Location writes.","format":"uint64","minimum":0,"type":"integer"}},"required":["created_at","geography_revision","location_id","metadata","name","status","timezone","updated_at","validation_status","version"],"type":"object"},"LocationAddress":{"properties":{"city":{"type":"string"},"country":{"description":"ISO 3166-1 alpha-2 country code.","example":"US","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"line1":{"type":"string"},"line2":{"type":"string"},"postal_code":{"type":"string"},"state":{"description":"State, province, or region.","type":"string"}},"type":"object"},"LocationCoordinate":{"properties":{"latitude":{"type":"number"},"longitude":{"type":"number"}},"type":"object"},"LocationInventory":{"description":"The inventory capability on a Location. Present only when the caller holds commerce.inventory.read.","properties":{"allocation_status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"inventory_revision":{"format":"uint64","minimum":0,"type":"integer"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["allocation_status","created_at","inventory_revision","updated_at"],"type":"object"},"LocationInventoryInput":{"properties":{"allocation_status":{"default":"active","enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"}},"type":"object"},"LocationInventoryResponse":{"properties":{"data":{"$ref":"#/components/schemas/LocationInventory"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"LocationListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Location"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"LocationResponse":{"properties":{"data":{"$ref":"#/components/schemas/Location"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ManualDiscountInput":{"additionalProperties":false,"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"discount_class":{"enum":["order","line_item","service_charge"],"type":"string","x-enum-descriptions":["Order.","Line item.","Service charge."],"x-flint-enum":"closed"},"name":{"type":"string"},"order_charge_ids":{"items":{"type":"string"},"type":"array"},"order_line_item_ids":{"items":{"type":"string"},"type":"array"},"scope":{"enum":["order","line_item"],"type":"string","x-enum-descriptions":["Order.","Line item."],"x-flint-enum":"closed"}},"required":["amount_money","name"],"type":"object"},"Merchant":{"properties":{"address":{"$ref":"#/components/schemas/Address"},"api_version":{"description":"Default API version for requests without a Flint-Version header. Shared across live and test environments.","type":"string"},"api_version_changed_at":{"description":"When the merchant's default API version last changed.","format":"date-time","readOnly":true,"type":"string"},"api_version_pinned_at":{"description":"When the merchant's default API version was first set.","format":"date-time","readOnly":true,"type":"string"},"api_version_previous":{"description":"Previous API version, present while a supported rollback is available.","readOnly":true,"type":"string"},"api_version_rollback_expires_at":{"description":"When the 72-hour rollback offer expires. Explicit changes to any supported version remain available afterward.","format":"date-time","readOnly":true,"type":"string"},"banners":{"items":{"$ref":"#/components/schemas/Banner"},"readOnly":true,"type":"array"},"business_name":{"readOnly":true,"type":"string"},"business_type":{"description":"Flint-normalized business profile type. Unknown backend/provider values are returned as unknown.","enum":["individual","company","non_profit","government_entity","unknown"],"readOnly":true,"type":"string","x-enum-descriptions":["Individual.","Company.","Non profit.","Government entity.","Unknown."],"x-flint-enum":"closed"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"current_deadline_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"email":{"type":"string"},"has_past_due":{"description":"Whether Flint's synced readiness projection has past-due account requirements.","readOnly":true,"type":"boolean"},"logo":{"$ref":"#/components/schemas/Image"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"observed_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"onboarding_status":{"description":"Activation lifecycle status. A merchant can remain completed after activation while later readiness fields or requirements show current account attention is needed.","enum":["not_started","in_progress","completed"],"readOnly":true,"type":"string","x-enum-descriptions":["Not started.","In progress.","Completed."],"x-flint-enum":"open"},"organization":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrganizationSummary"},{"type":"null"}],"readOnly":true},"organization_id":{"type":"string"},"payments":{"$ref":"#/components/schemas/MerchantReadinessAxis","readOnly":true},"payouts":{"$ref":"#/components/schemas/MerchantReadinessAxis","readOnly":true},"phone":{"type":"string"},"requirements":{"$ref":"#/components/schemas/MerchantReadinessRequirements","readOnly":true},"status":{"enum":["active","suspended","restricted","closed"],"readOnly":true,"type":"string","x-enum-descriptions":["Active.","Suspended.","Restricted.","Closed."],"x-flint-enum":"open"},"status_reason":{"readOnly":true,"type":"string"},"support_email":{"type":"string"},"support_phone":{"type":"string"},"support_url":{"type":"string"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"version":{"description":"Profile version. Changes to contact details, metadata, organization, support details, or logo advance this version. Readiness updates do not.","format":"int64","minimum":1,"readOnly":true,"type":"integer"},"website_url":{"type":"string"}},"required":["email","has_past_due","merchant_id","observed_at","onboarding_status","payments","payouts","requirements","status","version"],"type":"object"},"MerchantAccountSession":{"properties":{"components":{"items":{"enum":["account_onboarding","account_management","payouts","balances","tax_documents","notification_banner"],"type":"string","x-enum-descriptions":["Account onboarding.","Account management.","Payouts.","Balances.","Tax documents.","Notification banner."],"x-flint-enum":"closed"},"minItems":1,"type":"array"},"effective_policy":{"$ref":"#/components/schemas/MerchantAccountSessionEffectivePolicy"},"external_action":{"$ref":"#/components/schemas/OnboardingExternalAction"},"requirements":{"$ref":"#/components/schemas/OnboardingRequirements"}},"required":["components","effective_policy","external_action","requirements"],"type":"object"},"MerchantAccountSessionCreateRequest":{"additionalProperties":false,"description":"Creates an embedded account session for a non-empty unique set of Flint components. At most one component may use onboarding policy fields.","properties":{"collection_strategy":{"enum":["upfront","incremental"],"type":"string","x-enum-descriptions":["Upfront.","Incremental."],"x-flint-enum":"closed"},"components":{"items":{"enum":["account_onboarding","account_management","payouts","balances","tax_documents","notification_banner"],"type":"string","x-enum-descriptions":["Account onboarding.","Account management.","Payouts.","Balances.","Tax documents.","Notification banner."],"x-flint-enum":"closed"},"maxItems":6,"minItems":1,"type":"array","uniqueItems":true},"future_requirements":{"enum":["omit","include"],"type":"string","x-enum-descriptions":["Omit.","Include."],"x-flint-enum":"closed"},"sandbox_id":{"type":"string"},"targeted_requirement_ids":{"items":{"type":"string"},"type":"array"}},"required":["components"],"type":"object"},"MerchantAccountSessionEffectivePolicy":{"properties":{"collection_strategy":{"enum":["upfront","incremental"],"type":"string","x-enum-descriptions":["Upfront.","Incremental."],"x-flint-enum":"closed"},"future_requirements":{"enum":["omit","include"],"type":"string","x-enum-descriptions":["Omit.","Include."],"x-flint-enum":"closed"},"targeting":{"enum":["none","all","all_due","targeted"],"type":"string","x-enum-descriptions":["None.","All.","All due.","Targeted."],"x-flint-enum":"closed"}},"required":["targeting"],"type":"object"},"MerchantAccountSessionRefreshRequest":{"additionalProperties":false,"description":"Refreshes a merchant account session from its signed launch token. No create fields are accepted.","properties":{"launch_token":{"type":"string"}},"required":["launch_token"],"type":"object"},"MerchantAccountSessionResponse":{"properties":{"data":{"$ref":"#/components/schemas/MerchantAccountSession"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"MerchantAccountSessionStripeCollectionOptions":{"properties":{"fields":{"type":"string"},"futureRequirements":{"type":"string"},"requirements":{"$ref":"#/components/schemas/MerchantAccountSessionStripeRequirements"}},"required":["fields","futureRequirements"],"type":"object"},"MerchantAccountSessionStripeComponentLaunch":{"properties":{"component":{"type":"string"},"component_props":{"$ref":"#/components/schemas/MerchantAccountSessionStripeComponentProps"}},"required":["component","component_props"],"type":"object"},"MerchantAccountSessionStripeComponentProps":{"properties":{"collectionOptions":{"$ref":"#/components/schemas/MerchantAccountSessionStripeCollectionOptions"}},"type":"object"},"MerchantAccountSessionStripeLaunch":{"properties":{"client_secret":{"type":"string"},"components":{"items":{"$ref":"#/components/schemas/MerchantAccountSessionStripeComponentLaunch"},"type":"array"},"publishable_key":{"type":"string"}},"required":["client_secret","components","publishable_key"],"type":"object"},"MerchantAccountSessionStripeRequirements":{"properties":{"only":{"items":{"type":"string"},"type":"array"}},"required":["only"],"type":"object"},"MerchantBillingBalance":{"description":"Current Flint merchant billing balance for one billing account and currency.","properties":{"available_credit_money":{"$ref":"#/components/schemas/Money"},"merchant_billing_balance_id":{"description":"Stable identifier for this billing account and currency balance projection.","type":"string"},"observed_at":{"description":"RFC3339 timestamp for the balance snapshot.","format":"date-time","type":"string"},"outstanding_money":{"$ref":"#/components/schemas/Money"}},"required":["available_credit_money","merchant_billing_balance_id","observed_at","outstanding_money"],"type":"object"},"MerchantBillingBalanceListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/MerchantBillingBalance"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"MerchantBillingBalanceResponse":{"properties":{"data":{"$ref":"#/components/schemas/MerchantBillingBalance"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"MerchantReadinessAxis":{"properties":{"next_actions":{"items":{"$ref":"#/components/schemas/NextAction"},"type":"array"},"status":{"enum":["ready","blocked","pending","not_available","not_requested"],"type":"string","x-enum-descriptions":["Ready.","Blocked.","Pending.","Not available.","Not requested."],"x-flint-enum":"open"},"status_reason":{"enum":["requirements_due","requirements_past_due","pending_verification","disabled_by_platform_policy","service_unavailable","onboarding_not_started",null],"type":["string","null"],"x-enum-descriptions":["Requirements due.","Requirements past due.","Pending verification.","Disabled by platform policy.","Service unavailable.","Onboarding not started.","Null."],"x-flint-enum":"closed"}},"required":["next_actions","status"],"type":"object"},"MerchantReadinessRequirements":{"properties":{"current_deadline_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"currently_due":{"items":{"type":"string"},"type":"array"},"disabled_reason":{"enum":["account_attention_required","account_paused","account_rejected","account_requirements_due","account_under_review","requirements_past_due","requirements_pending_verification",null],"type":["string","null"],"x-enum-descriptions":["Account attention required.","Account paused.","Account rejected.","Account requirements due.","Account under review.","Requirements past due.","Requirements pending verification.","Null."],"x-flint-enum":"closed"},"eventually_due":{"items":{"type":"string"},"type":"array"},"past_due":{"items":{"type":"string"},"type":"array"},"pending_verification":{"items":{"type":"string"},"type":"array"}},"required":["currently_due","eventually_due","past_due","pending_verification"],"type":"object"},"MerchantResponse":{"properties":{"data":{"$ref":"#/components/schemas/Merchant"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"MerchantSubscriptionInvoice":{"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"credit_money":{"$ref":"#/components/schemas/Money"},"due_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"invoice_number":{"type":"string"},"issued_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"lines":{"items":{"$ref":"#/components/schemas/MerchantSubscriptionInvoiceLine"},"type":"array"},"merchant_subscription_invoice_id":{"type":"string"},"outstanding_money":{"$ref":"#/components/schemas/Money"},"paid_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"period_end":{"type":"string"},"period_start":{"type":"string"},"status":{"enum":["draft","open","collecting","paid","delinquent","void","written_off"],"type":"string","x-enum-descriptions":["Draft.","Open.","Collecting.","Paid.","Delinquent.","Void.","Written off."],"x-flint-enum":"open"},"subtotal_money":{"$ref":"#/components/schemas/Money"},"total_money":{"$ref":"#/components/schemas/Money"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"voided_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["created_at","credit_money","due_at","invoice_number","lines","merchant_subscription_invoice_id","outstanding_money","period_end","period_start","status","subtotal_money","total_money","updated_at"],"type":"object"},"MerchantSubscriptionInvoiceLine":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"description":{"type":"string"},"line_type":{"enum":["subscription","credit"],"type":"string","x-enum-descriptions":["Subscription.","Credit."],"x-flint-enum":"closed"},"merchant_subscription_invoice_line_id":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"unit_amount_money":{"$ref":"#/components/schemas/Money"}},"required":["amount_money","created_at","description","line_type","merchant_subscription_invoice_line_id","quantity","unit_amount_money"],"type":"object"},"MerchantSubscriptionInvoiceListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/MerchantSubscriptionInvoice"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"MerchantSubscriptionInvoiceResponse":{"properties":{"data":{"$ref":"#/components/schemas/MerchantSubscriptionInvoice"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"MerchantWebhookEnvelope":{"properties":{"api_version":{"format":"date","type":"string"},"created_at":{"format":"date-time","type":"string"},"data":{"additionalProperties":true,"type":"object"},"event_type":{"enum":["balance.updated","balance_transaction.created","balance_transaction.updated","capability.updated","checkout_session.completed","checkout_session.closed","checkout_session.expired","checkout_session.invalidated","credit_note.allocation_created","credit_note.allocation_reversed","credit_note.created","credit_note.issued","credit_note.updated","credit_note.voided","customer.created","customer.deletion_completed","customer.deletion_rejected","customer.deletion_requested","customer.updated","dispute.closed","dispute.created","dispute.lost","dispute.needs_response","dispute.prevented","dispute.updated","dispute.warning_closed","dispute.won","fraud_warning.created","fraud_warning.updated","delivery_rate_callback.archived","delivery_rate_callback.created","delivery_rate_callback.deactivated","delivery_rate_callback.activated","delivery_rate_callback.updated","delivery_method.archived","delivery_method.created","delivery_method.deactivated","delivery_method.activated","delivery_method.updated","delivery_location_set.archived","delivery_location_set.created","delivery_location_set.deactivated","delivery_location_set.activated","delivery_location_set.updated","delivery_profile.archived","delivery_profile.created","delivery_profile.deactivated","delivery_profile.activated","delivery_profile.updated","delivery_rate.archived","delivery_rate.created","delivery_rate.updated","delivery_revocation.created","delivery_selection.committed","delivery_zone.archived","delivery_zone.created","delivery_zone.deactivated","delivery_zone.activated","delivery_zone.updated","invoice.collection_block_resolved","invoice.collection_blocked","invoice.credited","invoice.created","invoice.delivery_failed","invoice.delivery_succeeded","invoice.issued","invoice.issue_failed","invoice.late_fee_due","invoice.late_fee_assessed","invoice.late_fee_waived","invoice.marked_uncollectible","invoice.manual_payment_recorded","invoice.manual_payment_reversed","invoice.overdue","invoice.paid","invoice.payment_processing","invoice.payment_attempt_canceled","invoice.payment_attempt_expired","invoice.payment_failed","invoice.partially_paid","invoice.partially_refunded","invoice.refunded","invoice.reminder_due","invoice.sent","invoice.updated","invoice.voided","inventory.action_required","inventory.count.applied","inventory.level.updated","inventory.receipt.created","inventory.reservation.at_risk","inventory.reservation.closed","inventory.reservation.committed","inventory.reservation.consumed","inventory.reservation.created","inventory.reservation.hold_expired","inventory.reservation.released","inventory.shortage.detected","inventory.transfer.closed","inventory.transfer.departed","inventory.transfer.lost","inventory.transfer.received","inventory.transfer.returned","merchant_billing_balance.updated","merchant.readiness.updated","merchant_subscription_invoice.issued","merchant_subscription_invoice.updated","order.closed","order.created","order.fulfillment.completed","order.fulfillment.created","order.fulfillment.event.created","order.fulfillment.package.created","order.fulfillment.package.updated","order.fulfillment.shipment.created","order.fulfillment.shipment.updated","order.fulfillment.status_changed","order.fulfillment.updated","order.inventory_action_required","order.inventory_exception.created","order.inventory_exception.resolved","order.payment_authorization_expired","order.payment_authorization_canceled","order.payment_authorized","order.payment_captured","order.partially_paid","order.paid","order.refunded","order.updated","payment_intent.canceled","payment_intent.fulfillment_hold.updated","payment_intent.payment_failed","payment_intent.processing","payment_intent.requires_action","payment_intent.requires_capture","payment_intent.succeeded","payment_method.failed","payment_method.removed","payment_method.saved","payout.canceled","payout.created","payout.failed","payout.paid","payout.reversed","payout.updated","payout_destination.created","payout_destination.deleted","payout_destination.disabled","payout_destination.updated","payout_settings.updated","refund.created","refund.failed","refund.updated","report.failed","report.succeeded","return.canceled","return.completed","return.created","return.decision_recorded","return.reopened","return.updated","return_disposition.created","return_disposition.updated","return_inspection.acceptance_decided","return_inspection.created","return_inspection.superseded","return_receipt.created","return_receipt.superseded","return_receipt.verified","return_resolution.created","return_resolution.updated","review.closed","review.opened","subscription.activated","subscription.canceled","subscription.created","subscription.dunning_exhausted","subscription.past_due","subscription.paused","subscription.payment_failed","subscription.payment_succeeded","subscription.resumed","subscription.renewal_upcoming","subscription.trial_ending","subscription.updated"],"type":"string","x-enum-descriptions":["Balance.updated.","Balance transaction.created.","Balance transaction.updated.","Capability.updated.","Checkout session.completed.","Checkout session.closed.","Checkout session.expired.","Checkout session.invalidated.","Credit note.allocation created.","Credit note.allocation reversed.","Credit note.created.","Credit note.issued.","Credit note.updated.","Credit note.voided.","Customer.created.","Customer.deletion completed.","Customer.deletion rejected.","Customer.deletion requested.","Customer.updated.","Dispute.closed.","Dispute.created.","Dispute.lost.","Dispute.needs response.","Dispute.prevented.","Dispute.updated.","Dispute.warning closed.","Dispute.won.","Fraud warning.created.","Fraud warning.updated.","Delivery rate callback.archived.","Delivery rate callback.created.","Delivery rate callback.deactivated.","Delivery rate callback.activated.","Delivery rate callback.updated.","Delivery method.archived.","Delivery method.created.","Delivery method.deactivated.","Delivery method.activated.","Delivery method.updated.","Delivery location set.archived.","Delivery location set.created.","Delivery location set.deactivated.","Delivery location set.activated.","Delivery location set.updated.","Delivery profile.archived.","Delivery profile.created.","Delivery profile.deactivated.","Delivery profile.activated.","Delivery profile.updated.","Delivery rate.archived.","Delivery rate.created.","Delivery rate.updated.","Delivery revocation.created.","Delivery selection.committed.","Delivery zone.archived.","Delivery zone.created.","Delivery zone.deactivated.","Delivery zone.activated.","Delivery zone.updated.","Invoice.collection block resolved.","Invoice.collection blocked.","Invoice.credited.","Invoice.created.","Invoice.delivery failed.","Invoice.delivery succeeded.","Invoice.issued.","Invoice.issue failed.","Invoice.late fee due.","Invoice.late fee assessed.","Invoice.late fee waived.","Invoice.marked uncollectible.","Invoice.manual payment recorded.","Invoice.manual payment reversed.","Invoice.overdue.","Invoice.paid.","Invoice.payment processing.","Invoice.payment attempt canceled.","Invoice.payment attempt expired.","Invoice.payment failed.","Invoice.partially paid.","Invoice.partially refunded.","Invoice.refunded.","Invoice.reminder due.","Invoice.sent.","Invoice.updated.","Invoice.voided.","Inventory.action required.","Inventory.count.applied.","Inventory.level.updated.","Inventory.receipt.created.","Inventory.reservation.at risk.","Inventory.reservation.closed.","Inventory.reservation.committed.","Inventory.reservation.consumed.","Inventory.reservation.created.","Inventory.reservation.hold expired.","Inventory.reservation.released.","Inventory.shortage.detected.","Inventory.transfer.closed.","Inventory.transfer.departed.","Inventory.transfer.lost.","Inventory.transfer.received.","Inventory.transfer.returned.","Merchant billing balance.updated.","Merchant.readiness.updated.","Merchant subscription invoice.issued.","Merchant subscription invoice.updated.","Order.closed.","Order.created.","Order.fulfillment.completed.","Order.fulfillment.created.","Order.fulfillment.event.created.","Order.fulfillment.package.created.","Order.fulfillment.package.updated.","Order.fulfillment.shipment.created.","Order.fulfillment.shipment.updated.","Order.fulfillment.status changed.","Order.fulfillment.updated.","Order.inventory action required.","Order.inventory exception.created.","Order.inventory exception.resolved.","Order.payment authorization expired.","Order.payment authorization canceled.","Order.payment authorized.","Order.payment captured.","Order.partially paid.","Order.paid.","Order.refunded.","Order.updated.","Payment intent.canceled.","Payment intent.fulfillment hold.updated.","Payment intent.payment failed.","Payment intent.processing.","Payment intent.requires action.","Payment intent.requires capture.","Payment intent.succeeded.","Payment method.failed.","Payment method.removed.","Payment method.saved.","Payout.canceled.","Payout.created.","Payout.failed.","Payout.paid.","Payout.reversed.","Payout.updated.","Payout destination.created.","Payout destination.deleted.","Payout destination.disabled.","Payout destination.updated.","Payout settings.updated.","Refund.created.","Refund.failed.","Refund.updated.","Report.failed.","Report.succeeded.","Return.canceled.","Return.completed.","Return.created.","Return.decision recorded.","Return.reopened.","Return.updated.","Return disposition.created.","Return disposition.updated.","Return inspection.acceptance decided.","Return inspection.created.","Return inspection.superseded.","Return receipt.created.","Return receipt.superseded.","Return receipt.verified.","Return resolution.created.","Return resolution.updated.","Review.closed.","Review.opened.","Subscription.activated.","Subscription.canceled.","Subscription.created.","Subscription.dunning exhausted.","Subscription.past due.","Subscription.paused.","Subscription.payment failed.","Subscription.payment succeeded.","Subscription.resumed.","Subscription.renewal upcoming.","Subscription.trial ending.","Subscription.updated."],"x-flint-enum":"closed"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"payload_version":{"minimum":1,"type":"integer"},"request":{"additionalProperties":false,"properties":{"id":{"type":"string"},"idempotency_key":{"type":"string"}},"required":["id","idempotency_key"],"type":["object","null"]},"test":{"type":"boolean"},"webhook_event_id":{"type":"string"}},"required":["webhook_event_id","event_type","payload_version","api_version","mode","merchant_id","created_at","request","data"],"type":"object"},"Modifier":{"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"default_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"line_item_tax_category":{"description":"Flint line-item tax category.","enum":["general","physical_goods","digital_goods","software","saas","services","professional_services","food","prepared_food","clothing","medical_goods","admission"],"type":"string","x-enum-descriptions":["General.","Physical goods.","Digital goods.","Software.","Saas.","Services.","Professional services.","Food.","Prepared food.","Clothing.","Medical goods.","Admission."],"x-flint-enum":"closed"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"modifier_group_id":{"readOnly":true,"type":"string"},"modifier_id":{"readOnly":true,"type":"string"},"name":{"type":"string"},"position":{"format":"int32","type":"integer"},"selected_by_default":{"type":"boolean"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"status":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"},"taxable":{"type":"boolean"},"unit_price_delta_money":{"$ref":"#/components/schemas/Money"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"}},"required":["modifier_id","name","position","selected_by_default","show_on_fulfillment","show_on_receipt","status"],"type":"object"},"ModifierGroup":{"properties":{"allow_quantities":{"type":"boolean"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"max_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"max_selected":{"format":"int32","type":"integer"},"max_total_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"min_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"min_selected":{"format":"int32","type":"integer"},"modifier_group_id":{"readOnly":true,"type":"string"},"modifier_group_type":{"enum":["list","text"],"type":"string","x-enum-descriptions":["List.","Text."],"x-flint-enum":"closed"},"modifiers":{"items":{"$ref":"#/components/schemas/Modifier"},"type":"array"},"name":{"type":"string"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"status":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"},"text":{"$ref":"#/components/schemas/TextModifierConfig"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"version":{"description":"Version of the modifier group and its modifiers.","format":"uint64","minimum":1,"readOnly":true,"type":"integer"}},"required":["allow_quantities","modifier_group_id","modifier_group_type","name","show_on_fulfillment","show_on_receipt","status","version"],"type":"object"},"ModifierGroupListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ModifierGroup"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ModifierGroupResponse":{"properties":{"data":{"$ref":"#/components/schemas/ModifierGroup"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ModifierInput":{"properties":{"default_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"line_item_tax_category":{"description":"Flint line-item tax category.","enum":["general","physical_goods","digital_goods","software","saas","services","professional_services","food","prepared_food","clothing","medical_goods","admission"],"type":"string","x-enum-descriptions":["General.","Physical goods.","Digital goods.","Software.","Saas.","Services.","Professional services.","Food.","Prepared food.","Clothing.","Medical goods.","Admission."],"x-flint-enum":"closed"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"modifier_id":{"pattern":"^mod_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"name":{"type":"string"},"position":{"format":"int32","type":"integer"},"selected_by_default":{"default":false,"type":"boolean"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"taxable":{"type":"boolean"},"unit_price_delta_money":{"$ref":"#/components/schemas/Money"}},"required":["name"],"type":"object"},"ModifierOverride":{"properties":{"available":{"type":"boolean"},"default_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"hidden":{"type":"boolean"},"line_item_tax_category":{"description":"Flint line-item tax category.","enum":["general","physical_goods","digital_goods","software","saas","services","professional_services","food","prepared_food","clothing","medical_goods","admission"],"type":"string","x-enum-descriptions":["General.","Physical goods.","Digital goods.","Software.","Saas.","Services.","Professional services.","Food.","Prepared food.","Clothing.","Medical goods.","Admission."],"x-flint-enum":"closed"},"modifier_id":{"type":"string"},"selected_by_default":{"type":"boolean"},"taxable":{"type":"boolean"},"unit_price_delta_money":{"$ref":"#/components/schemas/Money"}},"required":["modifier_id"],"type":"object"},"ModifierSet":{"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"modifier_groups":{"items":{"$ref":"#/components/schemas/ModifierSetGroup"},"type":"array"},"modifier_set_id":{"readOnly":true,"type":"string"},"name":{"type":"string"},"status":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"version":{"format":"uint64","minimum":1,"readOnly":true,"type":"integer"}},"required":["modifier_set_id","name","status","version"],"type":"object"},"ModifierSetGroup":{"additionalProperties":false,"discriminator":{"propertyName":"source"},"oneOf":[{"not":{"required":["modifier_group"]},"properties":{"source":{"enum":["existing"],"type":"string","x-enum-descriptions":["Existing."],"x-flint-enum":"closed"}},"required":["source","modifier_group_id","modifier_group_name"]},{"not":{"required":["modifier_group_id"]},"properties":{"source":{"enum":["inline"],"type":"string","x-enum-descriptions":["Inline."],"x-flint-enum":"closed"}},"required":["source","modifier_group"]}],"properties":{"display_name":{"type":"string"},"max_selected":{"format":"int32","type":"integer"},"min_selected":{"format":"int32","type":"integer"},"modifier_group":{"$ref":"#/components/schemas/ModifierGroup"},"modifier_group_id":{"type":"string"},"modifier_group_name":{"description":"Current name of the referenced modifier group.","type":"string"},"modifier_overrides":{"items":{"$ref":"#/components/schemas/ModifierOverride"},"type":"array"},"modifier_set_group_id":{"type":"string"},"position":{"format":"int32","type":"integer"},"required":{"type":"boolean"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"source":{"description":"Inline groups are owned by this modifier set. Existing groups are independent resources referenced by this set.","enum":["existing","inline"],"type":"string","x-enum-descriptions":["Existing.","Inline."],"x-flint-enum":"closed"}},"required":["modifier_set_group_id","position","source"],"type":"object"},"ModifierSetGroupInput":{"additionalProperties":false,"discriminator":{"propertyName":"source"},"oneOf":[{"not":{"required":["modifier_group"]},"properties":{"source":{"enum":["existing"],"type":"string","x-enum-descriptions":["Existing."],"x-flint-enum":"closed"}},"required":["source","modifier_group_id"]},{"not":{"required":["modifier_group_id"]},"properties":{"source":{"enum":["inline"],"type":"string","x-enum-descriptions":["Inline."],"x-flint-enum":"closed"}},"required":["source","modifier_group"]}],"properties":{"display_name":{"type":"string"},"max_selected":{"format":"int32","type":"integer"},"min_selected":{"format":"int32","type":"integer"},"modifier_group":{"$ref":"#/components/schemas/InlineModifierGroupInput"},"modifier_group_id":{"pattern":"^mg_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"modifier_overrides":{"items":{"$ref":"#/components/schemas/ModifierOverride"},"type":"array"},"modifier_set_group_id":{"pattern":"^msg_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"position":{"format":"int32","type":"integer"},"required":{"type":"boolean"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"source":{"description":"Use inline for a modifier group owned by this modifier set, or existing to reference an independent modifier group.","enum":["existing","inline"],"type":"string","x-enum-descriptions":["Existing.","Inline."],"x-flint-enum":"closed"}},"required":["source"],"type":"object"},"ModifierSetListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ModifierSet"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ModifierSetResponse":{"properties":{"data":{"$ref":"#/components/schemas/ModifierSet"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"Money":{"additionalProperties":false,"description":"Monetary amount represented as integer minor units plus an ISO 4217 currency code.","properties":{"amount":{"description":"Amount in the currency's minor unit, such as cents for USD.","format":"int64","minimum":0,"type":"integer"},"currency":{"description":"ISO 4217 currency code for this amount.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"}},"required":["amount","currency"],"type":"object"},"MoneyMetric":{"properties":{"change_percent":{"type":"number"},"current_money":{"$ref":"#/components/schemas/SignedMoney"},"previous_money":{"$ref":"#/components/schemas/SignedMoney"}},"required":["current_money"],"type":"object"},"MoneyMovementBlockedReason":{"properties":{"code":{"type":"string"},"message":{"type":"string"},"next_steps":{"type":"string"},"param":{"type":"string"},"resolution_owner":{"enum":["merchant","flint","integrator","buyer"],"type":"string","x-enum-descriptions":["Merchant.","Flint.","Integrator.","Buyer."],"x-flint-enum":"closed"},"retryable":{"type":"boolean"}},"required":["code"],"type":"object"},"MoneyMovementHistoryMeta":{"properties":{"earliest_available_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"latest_reconciled_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"status":{"enum":["backfilling","partial","unavailable"],"type":"string","x-enum-descriptions":["Backfilling.","Partial.","Unavailable."],"x-flint-enum":"open"}},"required":["status"],"type":"object"},"MoneyMovementListMeta":{"properties":{"api_version":{"type":"string"},"history":{"$ref":"#/components/schemas/MoneyMovementHistoryMeta"},"idempotency_replayed":{"type":"boolean"},"request_id":{"type":"string"},"trace_id":{"type":"string"},"warnings":{"items":{"$ref":"#/components/schemas/ResponseWarning"},"type":"array"}},"type":"object"},"NextAction":{"properties":{"action_type":{"type":"string"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"merchant_account_session":{"$ref":"#/components/schemas/NextActionMerchantAccountSession","description":"Request body fields to send to POST /v1/merchant-account-sessions when action_type is create_merchant_account_session."},"reason_code":{"type":"string"},"reason_message":{"type":"string"},"required_fields":{"items":{"type":"string"},"type":"array"},"required_scope":{"description":"API key scope required to call the public endpoint in url, when the action points at another Flint API endpoint.","type":"string"},"requires_human_confirmation":{"type":"boolean"},"suggested_delay_milliseconds":{"format":"int32","type":"integer"},"url":{"description":"Public endpoint or launch URL for this remediation action, when applicable.","type":"string"}},"required":["action_type"],"type":"object"},"NextActionMerchantAccountSession":{"properties":{"collection_strategy":{"description":"Recommended verification collection breadth.","enum":["upfront","incremental"],"type":"string","x-enum-descriptions":["Upfront.","Incremental."],"x-flint-enum":"closed"},"component":{"description":"Resolver-recommended component to send to POST /v1/merchant-account-sessions.","enum":["account_onboarding","account_management","payouts","balances","tax_documents","notification_banner"],"type":"string","x-enum-descriptions":["Account onboarding.","Account management.","Payouts.","Balances.","Tax documents.","Notification banner."],"x-flint-enum":"closed"},"future_requirements":{"description":"Recommended future-requirement collection behavior.","enum":["omit","include"],"type":"string","x-enum-descriptions":["Omit.","Include."],"x-flint-enum":"closed"}},"required":["component"],"type":"object"},"OnboardingAdvanceRequest":{"properties":{"country":{"description":"ISO 3166-1 alpha-2 country code.","enum":["US"],"example":"US","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string","x-enum-descriptions":["US."],"x-flint-enum":"closed"},"profile":{"$ref":"#/components/schemas/OnboardingProfileInput"},"requested_capabilities":{"description":"Exact initial Flint capability set. Include accept_card_payments and receive_payouts together. Optionally include accept_ach_debit_payments, or omit the field to use the card and payout default set.","oneOf":[{"items":{"enum":["accept_card_payments","receive_payouts"],"type":"string","x-enum-descriptions":["Accept card payments.","Receive payouts."],"x-flint-enum":"closed"},"maxItems":2,"minItems":2,"type":"array","uniqueItems":true},{"items":{"enum":["accept_ach_debit_payments","accept_card_payments","receive_payouts"],"type":"string","x-enum-descriptions":["Accept ach debit payments.","Accept card payments.","Receive payouts."],"x-flint-enum":"closed"},"maxItems":3,"minItems":3,"type":"array","uniqueItems":true}]},"sandbox_id":{"type":"string"}},"type":"object"},"OnboardingExternalAction":{"$ref":"#/components/schemas/EmbeddedMerchantAccountSessionExternalAction"},"OnboardingLaunchRecommendedPolicy":{"properties":{"collection_strategy":{"enum":["upfront","incremental"],"type":"string","x-enum-descriptions":["Upfront.","Incremental."],"x-flint-enum":"closed"},"future_requirements":{"enum":["omit","include"],"type":"string","x-enum-descriptions":["Omit.","Include."],"x-flint-enum":"closed"}},"required":["collection_strategy","future_requirements"],"type":"object"},"OnboardingLaunchReference":{"properties":{"component":{"enum":["account_onboarding"],"type":"string","x-enum-descriptions":["Account onboarding."],"x-flint-enum":"closed"},"endpoint":{"type":"string"},"method":{"enum":["POST"],"type":"string","x-enum-descriptions":["POST."],"x-flint-enum":"closed"},"recommended_policy":{"$ref":"#/components/schemas/OnboardingLaunchRecommendedPolicy"},"sandbox_id":{"type":"string"}},"required":["component","endpoint","method","recommended_policy"],"type":"object"},"OnboardingNextStep":{"properties":{"code":{"type":"string"},"launch":{"$ref":"#/components/schemas/OnboardingLaunchReference"},"machine_completable":{"type":"boolean"},"owner":{"type":"string"},"required_fields":{"items":{"type":"string"},"type":"array"},"submit_endpoint":{"type":"string"},"submit_method":{"type":"string"}},"required":["code","machine_completable","owner"],"type":"object"},"OnboardingProfile":{"properties":{"email":{"type":"string"},"support_email":{"type":"string"},"support_phone":{"type":"string"},"support_url":{"type":"string"},"website_url":{"type":"string"}},"required":["email"],"type":"object"},"OnboardingProfileInput":{"properties":{"email":{"type":"string"},"support_email":{"type":"string"},"support_phone":{"type":"string"},"support_url":{"type":"string"},"website_url":{"type":"string"}},"type":"object"},"OnboardingRequirements":{"properties":{"current_deadline_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"currently_due":{"description":"Documented Flint onboarding requirement codes. Unknown provider fields are returned as additional_account_information.","items":{"enum":["additional_account_information","business_address","business_description","business_directors","business_executives","business_name","business_owners","business_phone","business_support_phone","business_support_url","business_tax_id","business_verification_document","business_website","merchant_category_code","owner_address","owner_additional_identity_document","owner_date_of_birth","owner_first_name","owner_identity_document","owner_last_name","owner_tax_id_last_four","payout_destination","representative_address","representative_additional_identity_document","representative_date_of_birth","representative_email","representative_first_name","representative_identity_document","representative_last_name","representative_phone","representative_tax_id","representative_tax_id_last_four"],"type":"string","x-enum-descriptions":["Additional account information.","Business address.","Business description.","Business directors.","Business executives.","Business name.","Business owners.","Business phone.","Business support phone.","Business support url.","Business tax id.","Business verification document.","Business website.","Merchant category code.","Owner address.","Owner additional identity document.","Owner date of birth.","Owner first name.","Owner identity document.","Owner last name.","Owner tax id last four.","Payout destination.","Representative address.","Representative additional identity document.","Representative date of birth.","Representative email.","Representative first name.","Representative identity document.","Representative last name.","Representative phone.","Representative tax id.","Representative tax id last four."],"x-flint-enum":"closed"},"type":"array"},"disabled_reason":{"description":"Normalized reason the account still needs attention. Provider-specific raw reasons are mapped to these Flint public values.","enum":["account_attention_required","account_paused","account_rejected","account_requirements_due","account_under_review","requirements_past_due","requirements_pending_verification"],"type":"string","x-enum-descriptions":["Account attention required.","Account paused.","Account rejected.","Account requirements due.","Account under review.","Requirements past due.","Requirements pending verification."],"x-flint-enum":"closed"},"eventually_due":{"description":"Documented Flint onboarding requirement codes. Unknown provider fields are returned as additional_account_information.","items":{"enum":["additional_account_information","business_address","business_description","business_directors","business_executives","business_name","business_owners","business_phone","business_support_phone","business_support_url","business_tax_id","business_verification_document","business_website","merchant_category_code","owner_address","owner_additional_identity_document","owner_date_of_birth","owner_first_name","owner_identity_document","owner_last_name","owner_tax_id_last_four","payout_destination","representative_address","representative_additional_identity_document","representative_date_of_birth","representative_email","representative_first_name","representative_identity_document","representative_last_name","representative_phone","representative_tax_id","representative_tax_id_last_four"],"type":"string","x-enum-descriptions":["Additional account information.","Business address.","Business description.","Business directors.","Business executives.","Business name.","Business owners.","Business phone.","Business support phone.","Business support url.","Business tax id.","Business verification document.","Business website.","Merchant category code.","Owner address.","Owner additional identity document.","Owner date of birth.","Owner first name.","Owner identity document.","Owner last name.","Owner tax id last four.","Payout destination.","Representative address.","Representative additional identity document.","Representative date of birth.","Representative email.","Representative first name.","Representative identity document.","Representative last name.","Representative phone.","Representative tax id.","Representative tax id last four."],"x-flint-enum":"closed"},"type":"array"},"past_due":{"description":"Documented Flint onboarding requirement codes. Unknown provider fields are returned as additional_account_information.","items":{"enum":["additional_account_information","business_address","business_description","business_directors","business_executives","business_name","business_owners","business_phone","business_support_phone","business_support_url","business_tax_id","business_verification_document","business_website","merchant_category_code","owner_address","owner_additional_identity_document","owner_date_of_birth","owner_first_name","owner_identity_document","owner_last_name","owner_tax_id_last_four","payout_destination","representative_address","representative_additional_identity_document","representative_date_of_birth","representative_email","representative_first_name","representative_identity_document","representative_last_name","representative_phone","representative_tax_id","representative_tax_id_last_four"],"type":"string","x-enum-descriptions":["Additional account information.","Business address.","Business description.","Business directors.","Business executives.","Business name.","Business owners.","Business phone.","Business support phone.","Business support url.","Business tax id.","Business verification document.","Business website.","Merchant category code.","Owner address.","Owner additional identity document.","Owner date of birth.","Owner first name.","Owner identity document.","Owner last name.","Owner tax id last four.","Payout destination.","Representative address.","Representative additional identity document.","Representative date of birth.","Representative email.","Representative first name.","Representative identity document.","Representative last name.","Representative phone.","Representative tax id.","Representative tax id last four."],"x-flint-enum":"closed"},"type":"array"},"pending_verification":{"description":"Documented Flint onboarding requirement codes. Unknown provider fields are returned as additional_account_information.","items":{"enum":["additional_account_information","business_address","business_description","business_directors","business_executives","business_name","business_owners","business_phone","business_support_phone","business_support_url","business_tax_id","business_verification_document","business_website","merchant_category_code","owner_address","owner_additional_identity_document","owner_date_of_birth","owner_first_name","owner_identity_document","owner_last_name","owner_tax_id_last_four","payout_destination","representative_address","representative_additional_identity_document","representative_date_of_birth","representative_email","representative_first_name","representative_identity_document","representative_last_name","representative_phone","representative_tax_id","representative_tax_id_last_four"],"type":"string","x-enum-descriptions":["Additional account information.","Business address.","Business description.","Business directors.","Business executives.","Business name.","Business owners.","Business phone.","Business support phone.","Business support url.","Business tax id.","Business verification document.","Business website.","Merchant category code.","Owner address.","Owner additional identity document.","Owner date of birth.","Owner first name.","Owner identity document.","Owner last name.","Owner tax id last four.","Payout destination.","Representative address.","Representative additional identity document.","Representative date of birth.","Representative email.","Representative first name.","Representative identity document.","Representative last name.","Representative phone.","Representative tax id.","Representative tax id last four."],"x-flint-enum":"closed"},"type":"array"}},"type":"object"},"OnboardingStartRequest":{"properties":{"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"required":["email","first_name","last_name"],"type":"object"},"OnboardingStartResponse":{"properties":{"data":{"$ref":"#/components/schemas/OnboardingStartResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"OnboardingStartResult":{"properties":{"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"verification_started":{"type":"boolean"},"verification_token":{"type":"string"}},"required":["expires_at","verification_started","verification_token"],"type":"object"},"OnboardingState":{"properties":{"available_actions":{"items":{"$ref":"#/components/schemas/OnboardingNextStep"},"type":"array"},"can_issue_api_key":{"type":"boolean"},"capabilities_synced_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"country":{"description":"Immutable business country for the selected stable provider-account target. Omitted until the target has selected an effective country.","enum":["US"],"example":"US","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string","x-enum-descriptions":["US."],"x-flint-enum":"closed"},"default_sandbox_id":{"type":"string"},"email_verified":{"type":"boolean"},"merchant_created":{"type":"boolean"},"merchant_id":{"type":"string"},"next_step":{"$ref":"#/components/schemas/OnboardingNextStep"},"pending_steps":{"items":{"$ref":"#/components/schemas/OnboardingNextStep"},"type":"array"},"profile":{"$ref":"#/components/schemas/OnboardingProfile"},"readiness_observed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"requested_capabilities":{"description":"Canonical Flint capability intent persisted on the selected stable provider-account target. The initial merchant-account configuration always includes accept_card_payments and receive_payouts and may also include accept_ach_debit_payments.","oneOf":[{"items":{"enum":["accept_card_payments","receive_payouts"],"type":"string","x-enum-descriptions":["Accept card payments.","Receive payouts."],"x-flint-enum":"closed"},"maxItems":2,"minItems":2,"type":"array","uniqueItems":true},{"items":{"enum":["accept_ach_debit_payments","accept_card_payments","receive_payouts"],"type":"string","x-enum-descriptions":["Accept ach debit payments.","Accept card payments.","Receive payouts."],"x-flint-enum":"closed"},"maxItems":3,"minItems":3,"type":"array","uniqueItems":true}]},"requirements":{"$ref":"#/components/schemas/OnboardingRequirements"},"status":{"description":"Onboarding workflow status for activation and remediation, not a durable account-readiness boolean.","type":"string"}},"required":["can_issue_api_key","email_verified","merchant_created","merchant_id","profile","requirements","status"],"type":"object"},"OnboardingStateResponse":{"properties":{"data":{"$ref":"#/components/schemas/OnboardingState"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"OnboardingVerifyEmailRequest":{"properties":{"merchant_id":{"type":"string"},"verification_code":{"type":"string"},"verification_token":{"type":"string"}},"required":["verification_code","verification_token"],"type":"object"},"OnboardingVerifyEmailResponse":{"properties":{"data":{"$ref":"#/components/schemas/OnboardingVerifyEmailResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"OnboardingVerifyEmailResult":{"properties":{"can_issue_api_key":{"type":"boolean"},"default_sandbox_id":{"type":"string"},"merchant":{"$ref":"#/components/schemas/Merchant"},"merchant_created":{"type":"boolean"},"next_step":{"$ref":"#/components/schemas/OnboardingNextStep"},"onboarding_session_token":{"type":"string"},"status":{"type":"string"},"user":{"$ref":"#/components/schemas/User"}},"required":["can_issue_api_key","merchant","merchant_created","onboarding_session_token","status","user"],"type":"object"},"Order":{"properties":{"active_payment_attempt":{"$ref":"#/components/schemas/OrderPaymentAttempt","readOnly":true},"applied_discounts":{"items":{"$ref":"#/components/schemas/AppliedDiscount"},"readOnly":true,"type":"array"},"authorization_amounts":{"$ref":"#/components/schemas/OrderAuthorizationAmounts","readOnly":true},"buyer_email":{"readOnly":true,"type":"string"},"buyer_note":{"type":"string"},"charges":{"items":{"$ref":"#/components/schemas/OrderCharge"},"readOnly":true,"type":"array"},"checkout_session_ids":{"items":{"type":"string"},"readOnly":true,"type":"array"},"closed_reason":{"description":"Internal reason supplied when the order was closed. This is not shown to the buyer.","readOnly":true,"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"customer":{"anyOf":[{"$ref":"#/components/schemas/ExpandedCustomerSummary"},{"type":"null"}],"readOnly":true},"customer_id":{"type":"string"},"delivery_destination":{"$ref":"#/components/schemas/OrderDeliveryDestination","description":"The shipment or local-delivery destination committed for this order. Payment freezes this value; fulfillment recipient changes do not replace it."},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled","not_applicable","closed"],"readOnly":true,"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled.","Not applicable.","Closed."],"x-flint-enum":"open"},"fulfillments":{"items":{"$ref":"#/components/schemas/Fulfillment"},"readOnly":true,"type":"array"},"internal_note":{"type":"string"},"inventory_exception_status":{"enum":["paid_inventory_failed","resolved"],"readOnly":true,"type":"string","x-enum-descriptions":["Paid inventory failed.","Resolved."],"x-flint-enum":"open"},"inventory_reservation_id":{"description":"The reservation holding stock for this order, when one exists.","readOnly":true,"type":"string"},"inventory_routing_source":{"$ref":"#/components/schemas/InventoryRoutingSource","description":"Where this order's tracked demand is routed. Required before an order containing tracked variants can hold stock."},"line_items":{"items":{"$ref":"#/components/schemas/OrderLineItem"},"readOnly":true,"type":"array"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"readOnly":true,"type":"string"},"order_number":{"readOnly":true,"type":"string"},"origin":{"enum":["virtual_terminal","payment_link","checkout","api","subscription"],"readOnly":true,"type":"string","x-enum-descriptions":["Virtual terminal.","Payment link.","Checkout.","Api.","Subscription."],"x-flint-enum":"closed"},"payment_collection":{"$ref":"#/components/schemas/PaymentCollection","readOnly":true},"payment_intent_ids":{"items":{"type":"string"},"readOnly":true,"type":"array"},"payment_intents":{"items":{"$ref":"#/components/schemas/ExpandedPaymentIntentSummary"},"readOnly":true,"type":"array"},"payment_status":{"enum":["unpaid","partially_paid","paid"],"readOnly":true,"type":"string","x-enum-descriptions":["Unpaid.","Partially paid.","Paid."],"x-flint-enum":"open"},"plan_id":{"readOnly":true,"type":"string"},"pricing_amounts":{"$ref":"#/components/schemas/PricingAmounts","readOnly":true},"refund_ids":{"items":{"type":"string"},"readOnly":true,"type":"array"},"refund_status":{"enum":["none","partially_refunded","refunded"],"readOnly":true,"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"requested_tip":{"$ref":"#/components/schemas/RequestedTip"},"settlement_amounts":{"$ref":"#/components/schemas/SettlementAmounts","readOnly":true},"setup_collection":{"$ref":"#/components/schemas/PaymentCollection","readOnly":true},"status":{"enum":["open","closed"],"readOnly":true,"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"},"subscription":{"anyOf":[{"$ref":"#/components/schemas/ExpandedSubscriptionSummary"},{"type":"null"}],"readOnly":true},"subscription_id":{"readOnly":true,"type":"string"},"subscription_plan":{"anyOf":[{"$ref":"#/components/schemas/ExpandedSubscriptionPlanSummary"},{"type":"null"}],"readOnly":true},"tax":{"$ref":"#/components/schemas/OrderTax","readOnly":true},"tips":{"items":{"$ref":"#/components/schemas/Tip"},"readOnly":true,"type":"array"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"}},"required":["line_items","order_id","payment_status","pricing_amounts","refund_status","settlement_amounts","status","tax"],"type":"object"},"OrderActivity":{"description":"Read-only order history row for merchant timeline rendering and debugging. The owning resource remains authoritative for state and money movement.","properties":{"activity_type":{"description":"Stable but open activity string. Flint documents exactly the values it emits today; clients must still render unknown future values gracefully.","type":"string"},"balance_delta_money":{"$ref":"#/components/schemas/SignedMoney","description":"Change to the order balance narrated by this row. Informational rows have amount 0. Do not sum activity deltas to compute the order balance."},"checkout_session_id":{"description":"Related checkout session when activity_type points at checkout session lifecycle.","type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"description":{"description":"Human-readable Flint description. Provider-specific raw statuses and failure values are not exposed here.","type":"string"},"fulfillment_id":{"type":"string"},"order_activity_id":{"type":"string"},"order_charge_id":{"type":"string"},"order_discount_id":{"type":"string"},"order_line_item_id":{"type":"string"},"order_tip_id":{"type":"string"},"payment_intent_id":{"description":"Related payment intent when activity_type points at a payment attempt or payment outcome.","type":"string"},"refund_id":{"description":"Related refund when activity_type points at a refund outcome. Read the refund for the authoritative outcome.","type":"string"},"running_balance_money":{"$ref":"#/components/schemas/SignedMoney","description":"Order balance after this activity in chronological time. This is context for reading the log, not a reconciliation ledger."}},"required":["activity_type","balance_delta_money","description","order_activity_id","running_balance_money"],"type":"object"},"OrderActivityListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OrderActivity"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"OrderAuthorizationAmounts":{"properties":{"authorized_money":{"$ref":"#/components/schemas/Money"},"capturable_money":{"$ref":"#/components/schemas/Money"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["authorized_money","capturable_money"],"type":"object"},"OrderCalculatedChargeTax":{"properties":{"calculation":{"$ref":"#/components/schemas/TaxCalculationInput"},"charge_tax_category":{"description":"Flint charge tax category.","enum":["service_fee","shipping","delivery","handling","surcharge"],"type":"string","x-enum-descriptions":["Service fee.","Shipping.","Delivery.","Handling.","Surcharge."],"x-flint-enum":"closed"},"taxable":{"type":"boolean"}},"type":"object"},"OrderCalculatedLineItemTax":{"properties":{"calculation":{"$ref":"#/components/schemas/TaxCalculationInput"},"line_item_tax_category":{"description":"Flint line-item tax category.","enum":["general","physical_goods","digital_goods","software","saas","services","professional_services","food","prepared_food","clothing","medical_goods","admission"],"type":"string","x-enum-descriptions":["General.","Physical goods.","Digital goods.","Software.","Saas.","Services.","Professional services.","Food.","Prepared food.","Clothing.","Medical goods.","Admission."],"x-flint-enum":"closed"},"taxable":{"type":"boolean"}},"type":"object"},"OrderCharge":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"applied_money":{"$ref":"#/components/schemas/Money","readOnly":true},"calculation_basis":{"enum":["subtotal_pre_discount","subtotal_post_discount"],"type":"string","x-enum-descriptions":["Subtotal pre discount.","Subtotal post discount."],"x-flint-enum":"closed"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"description":{"type":"string"},"fulfillment_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"order_charge_id":{"readOnly":true,"type":"string"},"percent":{"multipleOf":0.0001,"type":"number"},"refunded_money":{"$ref":"#/components/schemas/Money","readOnly":true},"tax":{"$ref":"#/components/schemas/OrderCalculatedChargeTax"},"tax_money":{"$ref":"#/components/schemas/Money","readOnly":true},"total_money":{"$ref":"#/components/schemas/Money","readOnly":true},"type":{"enum":["service_fee","delivery_fee","shipping_fee","handling_fee","packaging_fee","small_order_fee","service_area_fee","setup_fee","installation_fee","cleaning_fee","booking_fee","reservation_fee","ticket_fee","fulfillment_fee","restocking_fee","rush_fee","other"],"type":"string","x-enum-descriptions":["Service fee.","Delivery fee.","Shipping fee.","Handling fee.","Packaging fee.","Small order fee.","Service area fee.","Setup fee.","Installation fee.","Cleaning fee.","Booking fee.","Reservation fee.","Ticket fee.","Fulfillment fee.","Restocking fee.","Rush fee.","Other."],"x-flint-enum":"closed"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"}},"required":["applied_money","name","order_charge_id","refunded_money","tax_money","total_money","type"],"type":"object"},"OrderChargeInput":{"oneOf":[{"not":{"anyOf":[{"required":["percent"]}]},"required":["amount_money"]},{"not":{"anyOf":[{"required":["amount_money"]}]},"required":["percent"]}],"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"calculation_basis":{"enum":["subtotal_pre_discount","subtotal_post_discount"],"type":"string","x-enum-descriptions":["Subtotal pre discount.","Subtotal post discount."],"x-flint-enum":"closed"},"description":{"type":"string"},"fulfillment_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"percent":{"multipleOf":0.0001,"type":"number"},"tax":{"$ref":"#/components/schemas/OrderCalculatedChargeTax"},"type":{"enum":["service_fee","delivery_fee","shipping_fee","handling_fee","packaging_fee","small_order_fee","service_area_fee","setup_fee","installation_fee","cleaning_fee","booking_fee","reservation_fee","ticket_fee","fulfillment_fee","restocking_fee","rush_fee","other"],"type":"string","x-enum-descriptions":["Service fee.","Delivery fee.","Shipping fee.","Handling fee.","Packaging fee.","Small order fee.","Service area fee.","Setup fee.","Installation fee.","Cleaning fee.","Booking fee.","Reservation fee.","Ticket fee.","Fulfillment fee.","Restocking fee.","Rush fee.","Other."],"x-flint-enum":"closed"}},"required":["name","type"],"type":"object"},"OrderDeliveryDestination":{"properties":{"address":{"$ref":"#/components/schemas/OrderDeliveryDestinationAddress"},"delivery_selection_id":{"description":"Delivery selection that controls this destination, when checkout collected it.","type":"string"},"frozen_at":{"description":"Time payment froze this destination.","format":"date-time","type":"string"},"recipient":{"$ref":"#/components/schemas/OrderDeliveryDestinationRecipient"},"source":{"enum":["delivery_selection","api","dashboard"],"type":"string","x-enum-descriptions":["Delivery selection.","Api.","Dashboard."],"x-flint-enum":"closed"}},"required":["address","source"],"type":"object"},"OrderDeliveryDestinationAddress":{"properties":{"city":{"maxLength":100,"type":"string"},"country":{"description":"ISO 3166-1 alpha-2 country code.","example":"US","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"line1":{"maxLength":255,"type":"string"},"line2":{"maxLength":255,"type":"string"},"postal_code":{"maxLength":20,"type":"string"},"state":{"maxLength":100,"type":"string"}},"required":["country"],"type":"object"},"OrderDeliveryDestinationAddressInput":{"additionalProperties":false,"properties":{"city":{"maxLength":100,"minLength":1,"pattern":"\\S","type":"string"},"country":{"description":"ISO 3166-1 alpha-2 country code.","example":"US","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"line1":{"maxLength":255,"minLength":1,"pattern":"\\S","type":"string"},"line2":{"maxLength":255,"type":"string"},"postal_code":{"description":"Postal code when used by the destination country's postal format.","maxLength":20,"type":"string"},"state":{"description":"State, province, or region when used by the destination country's postal format.","maxLength":100,"type":"string"}},"required":["city","country","line1"],"type":"object"},"OrderDeliveryDestinationInput":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/OrderDeliveryDestinationAddressInput"},"recipient":{"$ref":"#/components/schemas/OrderDeliveryDestinationRecipientInput"}},"required":["address"],"type":"object"},"OrderDeliveryDestinationRecipient":{"properties":{"name":{"maxLength":255,"type":"string"},"phone":{"maxLength":30,"type":"string"}},"type":"object"},"OrderDeliveryDestinationRecipientInput":{"additionalProperties":false,"anyOf":[{"properties":{"name":{"minLength":1,"pattern":"\\S","type":"string"}},"required":["name"]},{"properties":{"phone":{"minLength":1,"pattern":"\\S","type":"string"}},"required":["phone"]}],"minProperties":1,"properties":{"name":{"maxLength":255,"type":"string"},"phone":{"maxLength":30,"type":"string"}},"type":"object"},"OrderDraftLineItemInventoryDemandInput":{"additionalProperties":false,"properties":{"inventory_item_id":{"type":"string"},"quantity_per_line_item_unit":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","maximum":9999,"minimum":1,"type":"integer"}},"required":["inventory_item_id","quantity_per_line_item_unit"],"type":"object"},"OrderDraftLineItemTaxCalculationInput":{"additionalProperties":false,"oneOf":[{"not":{"required":["components"]},"properties":{"mode":{"enum":["automatic"],"type":"string","x-enum-descriptions":["Automatic."],"x-flint-enum":"closed"}}},{"properties":{"mode":{"enum":["external"],"type":"string","x-enum-descriptions":["External."],"x-flint-enum":"closed"}},"required":["components"]}],"properties":{"components":{"items":{"$ref":"#/components/schemas/OrderDraftTaxComponentInput"},"minItems":1,"type":"array"},"mode":{"enum":["automatic","external"],"type":"string","x-enum-descriptions":["Automatic.","External."],"x-flint-enum":"closed"},"price_mode":{"enum":["additive","inclusive"],"type":"string","x-enum-descriptions":["Additive.","Inclusive."],"x-flint-enum":"closed"}},"required":["mode","price_mode"],"type":"object"},"OrderDraftLineItemTaxInput":{"additionalProperties":false,"properties":{"calculation":{"$ref":"#/components/schemas/OrderDraftLineItemTaxCalculationInput"},"line_item_tax_category":{"description":"Flint line-item tax category.","enum":["general","physical_goods","digital_goods","software","saas","services","professional_services","food","prepared_food","clothing","medical_goods","admission"],"type":"string","x-enum-descriptions":["General.","Physical goods.","Digital goods.","Software.","Saas.","Services.","Professional services.","Food.","Prepared food.","Clothing.","Medical goods.","Admission."],"x-flint-enum":"closed"},"taxable":{"type":"boolean"}},"type":"object"},"OrderDraftTaxComponentInput":{"additionalProperties":false,"not":{"required":["flat_money"]},"properties":{"calculation_type":{"default":"percentage","enum":["percentage"],"type":"string","x-enum-descriptions":["Percentage."],"x-flint-enum":"closed"},"flat_money":{"$ref":"#/components/schemas/Money"},"jurisdiction":{"$ref":"#/components/schemas/OrderDraftTaxJurisdictionInput"},"percentage":{"maximum":100,"minimum":0,"multipleOf":0.0001,"type":"number"},"tax_type":{"enum":["sales_tax","use_tax"],"type":"string","x-enum-descriptions":["Sales tax.","Use tax."],"x-flint-enum":"closed"}},"required":["jurisdiction","percentage","tax_type"],"type":"object"},"OrderDraftTaxJurisdictionInput":{"additionalProperties":false,"properties":{"code":{"type":"string"},"country":{"description":"ISO 3166-1 alpha-2 country code.","example":"US","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"level":{"enum":["state","county","city","district"],"type":"string","x-enum-descriptions":["State.","County.","City.","District."],"x-flint-enum":"closed"},"name":{"type":"string"},"state":{"type":"string"}},"required":["code","country","level","name","state"],"type":"object"},"OrderInventoryRoutingSourceInput":{"additionalProperties":false,"properties":{"inventory_allocation_policy_id":{"type":"string"},"inventory_allocation_policy_version_id":{"type":"string"},"location_id":{"type":"string"},"location_ids":{"items":{"type":"string"},"type":"array"},"type":{"enum":["fixed_location","policy","policy_version"],"type":"string","x-enum-descriptions":["Fixed location.","Policy.","Policy version."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"OrderLineItem":{"properties":{"base_subtotal_money":{"$ref":"#/components/schemas/Money"},"bundle_components":{"items":{"$ref":"#/components/schemas/BundleComponent"},"type":"array"},"bundle_id":{"type":"string"},"categories":{"items":{"$ref":"#/components/schemas/CategoryReference"},"type":"array"},"description":{"type":"string"},"discount_money":{"$ref":"#/components/schemas/Money"},"image":{"$ref":"#/components/schemas/Image"},"inventory_snapshot":{"$ref":"#/components/schemas/LineItemInventorySnapshot"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"modifier_total_money":{"$ref":"#/components/schemas/Money"},"modifiers":{"items":{"$ref":"#/components/schemas/OrderLineItemModifier"},"type":"array"},"name":{"type":"string"},"order_line_item_id":{"type":"string"},"product_id":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"refunded_money":{"$ref":"#/components/schemas/Money"},"refunded_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"selected_options":{"items":{"$ref":"#/components/schemas/SelectedProductOption"},"type":"array"},"sku":{"type":"string"},"source_type":{"enum":["variant","bundle"],"type":"string","x-enum-descriptions":["Variant.","Bundle."],"x-flint-enum":"closed"},"subtotal_money":{"$ref":"#/components/schemas/Money"},"tax":{"$ref":"#/components/schemas/OrderCalculatedLineItemTax"},"tax_money":{"$ref":"#/components/schemas/Money"},"total_money":{"$ref":"#/components/schemas/SignedMoney"},"unit_price_money":{"$ref":"#/components/schemas/Money"},"variant_id":{"type":"string"},"version":{"description":"Version to send as expected_version when replacing modifiers on this line item. Checkout-session reads return the checkout modifier version.","format":"uint64","minimum":1,"type":"integer"}},"required":["base_subtotal_money","discount_money","modifier_total_money","name","order_line_item_id","quantity","refunded_money","refunded_quantity","subtotal_money","tax_money","total_money","unit_price_money","version"],"type":"object"},"OrderLineItemModifier":{"properties":{"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"modifier_group_name":{"type":"string"},"modifier_id":{"type":"string"},"name":{"type":"string"},"order_line_item_modifier_id":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"source_type":{"type":"string"},"text":{"$ref":"#/components/schemas/TextModifierInput"},"text_value":{"type":"string"},"total_money":{"$ref":"#/components/schemas/Money"},"unit_price_delta_money":{"$ref":"#/components/schemas/Money"}},"required":["modifier_group_name","name","order_line_item_modifier_id","quantity","show_on_fulfillment","show_on_receipt","source_type","total_money","unit_price_delta_money"],"type":"object"},"OrderLineItemModifierInput":{"additionalProperties":false,"oneOf":[{"not":{"required":["text"]},"required":["modifier_id"]},{"not":{"anyOf":[{"required":["modifier_id"]},{"required":["quantity"]}]},"required":["text"]}],"properties":{"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"modifier_id":{"pattern":"^mod_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"order_line_item_modifier_id":{"description":"Existing selection ID to retain during replacement.","pattern":"^olim_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"text":{"$ref":"#/components/schemas/TextModifierInput"}},"type":"object"},"OrderLineItemTax":{"properties":{"line_item_tax_category":{"description":"Flint line-item tax category.","enum":["general","physical_goods","digital_goods","software","saas","services","professional_services","food","prepared_food","clothing","medical_goods","admission"],"type":"string","x-enum-descriptions":["General.","Physical goods.","Digital goods.","Software.","Saas.","Services.","Professional services.","Food.","Prepared food.","Clothing.","Medical goods.","Admission."],"x-flint-enum":"closed"},"taxable":{"type":"boolean"}},"type":"object"},"OrderListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Order"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"OrderPaymentAttempt":{"properties":{"completed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"expected_outstanding_money":{"$ref":"#/components/schemas/Money"},"failure_code":{"type":"string"},"failure_message":{"type":"string"},"is_resumable":{"type":"boolean"},"mode":{"enum":["payment","setup","settlement"],"type":"string","x-enum-descriptions":["Payment.","Setup.","Settlement."],"x-flint-enum":"closed"},"payment_attempt_id":{"type":"string"},"payment_intents":{"items":{"$ref":"#/components/schemas/PaymentAttemptPaymentIntent"},"type":"array"},"pending_actions":{"items":{"$ref":"#/components/schemas/PendingPaymentAction"},"type":"array"},"started_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"status":{"enum":["processing","requires_action","requires_capture","partially_succeeded","requires_retry","finalizing","succeeded","failed","expired","canceled"],"type":"string","x-enum-descriptions":["Processing.","Requires action.","Requires capture.","Partially succeeded.","Requires retry.","Finalizing.","Succeeded.","Failed.","Expired.","Canceled."],"x-flint-enum":"open"}},"required":["expected_outstanding_money","is_resumable","mode","payment_attempt_id","status"],"type":"object"},"OrderPaymentAttemptListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OrderPaymentAttempt"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"OrderPaymentAttemptResponse":{"properties":{"data":{"$ref":"#/components/schemas/OrderPaymentAttempt"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"OrderPaymentIntentSelection":{"properties":{"confirmation_token":{"type":"string"},"payment_intent_id":{"type":"string"},"payment_method_id":{"type":"string"},"token":{"type":"string"}},"required":["payment_intent_id"],"type":"object"},"OrderPaymentLifecycleResponse":{"properties":{"data":{"$ref":"#/components/schemas/OrderPaymentLifecycleResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"OrderPaymentLifecycleResult":{"properties":{"order":{"$ref":"#/components/schemas/Order"},"payment_attempt":{"$ref":"#/components/schemas/OrderPaymentAttempt"},"payment_intent":{"$ref":"#/components/schemas/PaymentIntent"}},"required":["order","payment_intent"],"type":"object"},"OrderPaymentSourceCardSelection":{"properties":{"digital_wallets":{"items":{"type":"string"},"type":"array"}},"type":"object"},"OrderPaymentSourceSelection":{"properties":{"card":{"$ref":"#/components/schemas/OrderPaymentSourceCardSelection"}},"type":"object"},"OrderResponse":{"properties":{"data":{"$ref":"#/components/schemas/Order"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"OrderTax":{"properties":{"automatic_profile":{"description":"Identifies which automatic tax behavior applies to this order.","enum":["standard","connected"],"type":"string","x-enum-descriptions":["Standard.","Connected."],"x-flint-enum":"closed"},"available_location_inputs":{"items":{"type":"string"},"type":"array"},"enabled":{"type":"boolean"},"exemption":{"$ref":"#/components/schemas/OrderTaxExemption"},"failure_reason":{"description":"Normalized reason the most recent tax calculation could not complete.","enum":["calculation_unavailable","location_unsupported","rate_unavailable"],"type":"string","x-enum-descriptions":["Calculation unavailable.","Location unsupported.","Rate unavailable."],"x-flint-enum":"closed"},"location":{"$ref":"#/components/schemas/OrderTaxLocation"},"mode":{"enum":["automatic","external"],"type":"string","x-enum-descriptions":["Automatic.","External."],"x-flint-enum":"closed"},"status":{"enum":["not_required","requires_location","calculated","exempt","incomplete"],"type":"string","x-enum-descriptions":["Not required.","Requires location.","Calculated.","Exempt.","Incomplete."],"x-flint-enum":"open"},"tax_breakdowns":{"items":{"$ref":"#/components/schemas/TaxBreakdown"},"type":"array"},"taxability_reason":{"description":"Explains why tax was charged or zero for this order.","enum":["standard_rated","not_taxable","customer_exempt","tax_disabled","no_jurisdiction","location_required"],"type":"string","x-enum-descriptions":["Standard rated.","Not taxable.","Customer exempt.","Tax disabled.","No jurisdiction.","Location required."],"x-flint-enum":"closed"}},"required":["enabled","mode","status","taxability_reason"],"type":"object"},"OrderTaxCalculationInput":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"properties":{"mode":{"enum":["automatic"],"type":"string","x-enum-descriptions":["Automatic."],"x-flint-enum":"closed"},"price_mode":{"enum":["additive","inclusive"],"type":"string","x-enum-descriptions":["Additive.","Inclusive."],"x-flint-enum":"closed"}},"required":["mode","price_mode"],"type":"object"},{"additionalProperties":false,"oneOf":[{"properties":{"components":{"maxItems":0}}},{"properties":{"components":{"minItems":1},"price_mode":{"enum":["additive"],"type":"string","x-enum-descriptions":["Additive."],"x-flint-enum":"closed"}},"required":["components"]}],"properties":{"components":{"items":{"$ref":"#/components/schemas/OrderTaxComponentInput"},"type":"array"},"mode":{"enum":["external"],"type":"string","x-enum-descriptions":["External."],"x-flint-enum":"closed"},"price_mode":{"enum":["additive","inclusive"],"type":"string","x-enum-descriptions":["Additive.","Inclusive."],"x-flint-enum":"closed"}},"required":["mode","price_mode"],"type":"object"}],"properties":{"components":{"items":{"$ref":"#/components/schemas/OrderTaxComponentInput"},"type":"array"},"mode":{"enum":["automatic","external"],"type":"string","x-enum-descriptions":["Automatic.","External."],"x-flint-enum":"closed"},"price_mode":{"enum":["additive","inclusive"],"type":"string","x-enum-descriptions":["Additive.","Inclusive."],"x-flint-enum":"closed"}},"required":["mode","price_mode"],"type":"object"},"OrderTaxComponentInput":{"additionalProperties":false,"not":{"required":["percentage"]},"properties":{"calculation_type":{"default":"flat_amount","enum":["flat_amount"],"type":"string","x-enum-descriptions":["Flat amount."],"x-flint-enum":"closed"},"flat_money":{"allOf":[{"$ref":"#/components/schemas/Money"}],"description":"Flat tax in the order currency. The amount must be at least 1 minor unit; otherwise, Flint returns INVALID_FLAT_TAX.","properties":{"amount":{"minimum":1}}},"jurisdiction":{"$ref":"#/components/schemas/OrderTaxJurisdictionInput"},"percentage":{"multipleOf":0.0001,"type":"number"},"tax_type":{"default":"retail_delivery_fee","enum":["retail_delivery_fee"],"type":"string","x-enum-descriptions":["Retail delivery fee."],"x-flint-enum":"closed"}},"required":["flat_money","jurisdiction"],"type":"object"},"OrderTaxExemption":{"properties":{"customer_id":{"type":"string"},"source":{"type":"string"},"tax_exempt":{"type":"boolean"}},"required":["source","tax_exempt"],"type":"object"},"OrderTaxInput":{"additionalProperties":false,"oneOf":[{"properties":{"enabled":{"enum":[true],"type":"boolean","x-enum-descriptions":["True."],"x-flint-enum":"closed"}}},{"not":{"anyOf":[{"required":["calculation"]},{"required":["location"]}]},"properties":{"enabled":{"enum":[false],"type":"boolean","x-enum-descriptions":["False."],"x-flint-enum":"closed"}},"required":["enabled"]}],"properties":{"calculation":{"$ref":"#/components/schemas/OrderTaxCalculationInput"},"enabled":{"default":true,"type":"boolean"},"location":{"$ref":"#/components/schemas/OrderTaxLocationInput"}},"type":"object"},"OrderTaxJurisdictionInput":{"additionalProperties":false,"properties":{"code":{"maxLength":128,"minLength":1,"pattern":"^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$","type":"string"},"country":{"description":"ISO 3166-1 alpha-2 country code.","enum":["US"],"example":"US","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string","x-enum-descriptions":["US."],"x-flint-enum":"closed"},"level":{"enum":["state","county","city","district"],"type":"string","x-enum-descriptions":["State.","County.","City.","District."],"x-flint-enum":"closed"},"name":{"maxLength":200,"minLength":1,"pattern":"^[^\\s\\x00](?:[^\\r\\n\\x00]*[^\\s\\x00])?$","type":"string"},"state":{"maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string"}},"required":["code","country","level","name","state"],"type":"object"},"OrderTaxLocation":{"properties":{"address":{"$ref":"#/components/schemas/Address"},"address_source":{"enum":["provided","fulfillment","customer","device","location","merchant"],"type":"string","x-enum-descriptions":["Provided.","Fulfillment.","Customer.","Device.","Location.","Merchant."],"x-flint-enum":"closed"},"address_type":{"enum":["postal_code","tax_address","billing_address","shipping_address","business_address"],"type":"string","x-enum-descriptions":["Postal code.","Tax address.","Billing address.","Shipping address.","Business address."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"}},"required":["address_source"],"type":"object"},"OrderTaxLocationFullAddressInput":{"additionalProperties":false,"properties":{"city":{"minLength":1,"pattern":"\\S","type":"string"},"country":{"description":"ISO 3166-1 alpha-2 country code.","enum":["US"],"example":"US","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string","x-enum-descriptions":["US."],"x-flint-enum":"closed"},"line1":{"minLength":1,"pattern":"\\S","type":"string"},"line2":{"type":"string"},"postal_code":{"minLength":1,"pattern":"\\S","type":"string"},"state":{"minLength":1,"pattern":"\\S","type":"string"}},"required":["line1","city","state","postal_code","country"],"type":"object"},"OrderTaxLocationInput":{"oneOf":[{"$ref":"#/components/schemas/OrderTaxLocationInputPostalCode"},{"$ref":"#/components/schemas/OrderTaxLocationInputFullAddress"},{"$ref":"#/components/schemas/OrderTaxLocationInputInferredPostalCode"},{"$ref":"#/components/schemas/OrderTaxLocationInputInferredFullAddress"}]},"OrderTaxLocationInputFullAddress":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/OrderTaxLocationFullAddressInput"},"address_source":{"default":"provided","enum":["provided"],"type":"string","x-enum-descriptions":["Provided."],"x-flint-enum":"closed"},"address_type":{"enum":["tax_address","billing_address","shipping_address"],"type":"string","x-enum-descriptions":["Tax address.","Billing address.","Shipping address."],"x-flint-enum":"closed"}},"required":["address","address_type"],"type":"object"},"OrderTaxLocationInputInferredFullAddress":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/OrderTaxLocationFullAddressInput"},"address_source":{"default":"provided","enum":["provided"],"type":"string","x-enum-descriptions":["Provided."],"x-flint-enum":"closed"}},"required":["address"],"type":"object"},"OrderTaxLocationInputInferredPostalCode":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/OrderTaxLocationPostalAddressInput"},"address_source":{"default":"provided","enum":["provided"],"type":"string","x-enum-descriptions":["Provided."],"x-flint-enum":"closed"}},"required":["address"],"type":"object"},"OrderTaxLocationInputPostalCode":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/OrderTaxLocationPostalAddressInput"},"address_source":{"default":"provided","enum":["provided"],"type":"string","x-enum-descriptions":["Provided."],"x-flint-enum":"closed"},"address_type":{"enum":["postal_code"],"type":"string","x-enum-descriptions":["Postal code."],"x-flint-enum":"closed"}},"required":["address","address_type"],"type":"object"},"OrderTaxLocationPostalAddressInput":{"additionalProperties":false,"properties":{"country":{"default":"US","description":"ISO 3166-1 alpha-2 country code.","enum":["US"],"example":"US","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string","x-enum-descriptions":["US."],"x-flint-enum":"closed"},"postal_code":{"minLength":1,"pattern":"\\S","type":"string"}},"required":["postal_code"],"type":"object"},"Organization":{"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"organization_id":{"readOnly":true,"type":"string"},"parent_organization":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrganizationSummary"},{"type":"null"}],"readOnly":true},"parent_organization_id":{"type":"string"},"status":{"enum":["active","deleted"],"readOnly":true,"type":"string","x-enum-descriptions":["Active.","Deleted."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"}},"required":["name","organization_id","status"],"type":"object"},"OrganizationListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Organization"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"OrganizationMembership":{"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"organization_id":{"type":"string"},"role":{"enum":["owner","admin","operator","viewer"],"type":"string","x-enum-descriptions":["Owner.","Admin.","Operator.","Viewer."],"x-flint-enum":"closed"},"status":{"enum":["active","revoked"],"type":"string","x-enum-descriptions":["Active.","Revoked."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"user_id":{"type":"string"}},"required":["organization_id","role","status","user_id"],"type":"object"},"OrganizationMembershipListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OrganizationMembership"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"OrganizationMembershipResponse":{"properties":{"data":{"$ref":"#/components/schemas/OrganizationMembership"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"OrganizationResponse":{"properties":{"data":{"$ref":"#/components/schemas/Organization"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"Package":{"properties":{"carrier":{"type":"string"},"created_at":{"description":"Creation timestamp.","format":"date-time","readOnly":true,"type":"string"},"delivered_at":{"description":"Package delivery timestamp.","format":"date-time","readOnly":true,"type":"string"},"dimensions":{"$ref":"#/components/schemas/ShippingDimensions"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system. Caller-owned package identifier in external_system. Set with external_system to enable duplicate detection and replay for that provider reference.","maxLength":255,"type":"string"},"external_system":{"description":"External carrier, aggregator, or fulfillment platform name for this package. Set with external_reference_id to enable duplicate detection and replay for that provider reference; without external_reference_id this is stored as provenance only.","type":"string"},"fulfillment_id":{"readOnly":true,"type":"string"},"label_url":{"description":"Merchant or integration supplied HTTPS shipping-label URL for authenticated merchant workflows. Non-Flint URLs must include external_system for provenance. Flint does not currently manage label file hosting or buyer-facing label downloads.","type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrderSummary"},{"type":"null"}],"readOnly":true},"order_id":{"readOnly":true,"type":"string"},"package_id":{"readOnly":true,"type":"string"},"service_code":{"type":"string"},"shipment_id":{"readOnly":true,"type":"string"},"shipped_at":{"description":"Package handoff timestamp.","format":"date-time","readOnly":true,"type":"string"},"status":{"description":"Current package lifecycle state. Package states are the source used to derive shipment status.\n- `created`: The package record exists but has not been packed or handed off.\n- `packed`: The package is packed and awaiting carrier handoff.\n- `shipped`: The package was handed to the carrier.\n- `in_transit`: The carrier is moving the package through its network.\n- `out_for_delivery`: The package is on its final delivery route.\n- `delivered`: The carrier reported successful delivery.\n- `delivery_attempted`: The carrier attempted delivery but did not complete it. Follow the carrier instructions before retrying delivery.\n- `exception`: A carrier exception is blocking normal progress. Resolve the carrier-reported issue.\n- `returned`: The package was returned toward or to its origin.\n- `voided`: The package was voided and will not continue through delivery.","enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"readOnly":true,"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open","x-flint-enum-descriptions":{"created":"The package record exists but has not been packed or handed off.","delivered":"The carrier reported successful delivery.","delivery_attempted":"The carrier attempted delivery but did not complete it. Follow the carrier instructions before retrying delivery.","exception":"A carrier exception is blocking normal progress. Resolve the carrier-reported issue.","in_transit":"The carrier is moving the package through its network.","out_for_delivery":"The package is on its final delivery route.","packed":"The package is packed and awaiting carrier handoff.","returned":"The package was returned toward or to its origin.","shipped":"The package was handed to the carrier.","voided":"The package was voided and will not continue through delivery."}},"status_reason":{"type":"string"},"supported_actions":{"description":"Read-only actions currently supported for this package.","items":{"enum":["mark_delivered","mark_delivery_attempted","mark_exception","mark_in_transit","mark_out_for_delivery","mark_packed","mark_returned","mark_shipped"],"type":"string","x-enum-descriptions":["Mark delivered.","Mark delivery attempted.","Mark exception.","Mark in transit.","Mark out for delivery.","Mark packed.","Mark returned.","Mark shipped."],"x-flint-enum":"closed"},"readOnly":true,"type":"array"},"tracking_number":{"type":"string"},"tracking_url":{"description":"Absolute HTTPS carrier tracking URL. Embedded URL credentials are rejected.","type":"string"},"updated_at":{"description":"Last update timestamp.","format":"date-time","readOnly":true,"type":"string"},"version":{"description":"Monotonic package version for expected_version checks.","format":"uint64","minimum":1,"readOnly":true,"type":"integer"},"weight":{"$ref":"#/components/schemas/ShippingWeight"}},"required":["fulfillment_id","order_id","package_id","shipment_id","status","supported_actions","version"],"type":"object"},"PackageItem":{"properties":{"created_at":{"description":"Creation timestamp.","format":"date-time","readOnly":true,"type":"string"},"fulfillment_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrderSummary"},{"type":"null"}],"readOnly":true},"order_id":{"readOnly":true,"type":"string"},"order_line_item_id":{"type":"string"},"package_id":{"readOnly":true,"type":"string"},"package_item_id":{"readOnly":true,"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"shipment_id":{"readOnly":true,"type":"string"},"updated_at":{"description":"Last update timestamp.","format":"date-time","readOnly":true,"type":"string"}},"required":["fulfillment_id","order_id","order_line_item_id","package_id","package_item_id","quantity","shipment_id"],"type":"object"},"PackageItemListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PackageItem"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PackageItemResponse":{"properties":{"data":{"$ref":"#/components/schemas/PackageItem"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PackageListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Package"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PackageResponse":{"properties":{"data":{"$ref":"#/components/schemas/Package"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PackageStatusUpdate":{"properties":{"buyer_notification_behavior":{"description":"Controls buyer email handling. Omit or use send to send when recipient, template, and deduplication rules allow it. Use suppress when another system owns buyer messaging.","enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"created_at":{"description":"Status update creation timestamp.","format":"date-time","type":"string"},"current_status":{"description":"Current package lifecycle state. Package states are the source used to derive shipment status.\n- `created`: The package record exists but has not been packed or handed off.\n- `packed`: The package is packed and awaiting carrier handoff.\n- `shipped`: The package was handed to the carrier.\n- `in_transit`: The carrier is moving the package through its network.\n- `out_for_delivery`: The package is on its final delivery route.\n- `delivered`: The carrier reported successful delivery.\n- `delivery_attempted`: The carrier attempted delivery but did not complete it. Follow the carrier instructions before retrying delivery.\n- `exception`: A carrier exception is blocking normal progress. Resolve the carrier-reported issue.\n- `returned`: The package was returned toward or to its origin.\n- `voided`: The package was voided and will not continue through delivery.","enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open","x-flint-enum-descriptions":{"created":"The package record exists but has not been packed or handed off.","delivered":"The carrier reported successful delivery.","delivery_attempted":"The carrier attempted delivery but did not complete it. Follow the carrier instructions before retrying delivery.","exception":"A carrier exception is blocking normal progress. Resolve the carrier-reported issue.","in_transit":"The carrier is moving the package through its network.","out_for_delivery":"The package is on its final delivery route.","packed":"The package is packed and awaiting carrier handoff.","returned":"The package was returned toward or to its origin.","shipped":"The package was handed to the carrier.","voided":"The package was voided and will not continue through delivery."}},"fulfillment_id":{"type":"string"},"occurred_at":{"description":"Package transition timestamp.","format":"date-time","type":"string"},"order":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrderSummary"},{"type":"null"}]},"order_id":{"type":"string"},"package_id":{"type":"string"},"package_status_update_id":{"type":"string"},"previous_status":{"description":"Current package lifecycle state. Package states are the source used to derive shipment status.\n- `created`: The package record exists but has not been packed or handed off.\n- `packed`: The package is packed and awaiting carrier handoff.\n- `shipped`: The package was handed to the carrier.\n- `in_transit`: The carrier is moving the package through its network.\n- `out_for_delivery`: The package is on its final delivery route.\n- `delivered`: The carrier reported successful delivery.\n- `delivery_attempted`: The carrier attempted delivery but did not complete it. Follow the carrier instructions before retrying delivery.\n- `exception`: A carrier exception is blocking normal progress. Resolve the carrier-reported issue.\n- `returned`: The package was returned toward or to its origin.\n- `voided`: The package was voided and will not continue through delivery.","enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open","x-flint-enum-descriptions":{"created":"The package record exists but has not been packed or handed off.","delivered":"The carrier reported successful delivery.","delivery_attempted":"The carrier attempted delivery but did not complete it. Follow the carrier instructions before retrying delivery.","exception":"A carrier exception is blocking normal progress. Resolve the carrier-reported issue.","in_transit":"The carrier is moving the package through its network.","out_for_delivery":"The package is on its final delivery route.","packed":"The package is packed and awaiting carrier handoff.","returned":"The package was returned toward or to its origin.","shipped":"The package was handed to the carrier.","voided":"The package was voided and will not continue through delivery."}},"reason":{"type":"string"},"shipment_id":{"type":"string"}},"required":["buyer_notification_behavior","current_status","fulfillment_id","order_id","package_id","package_status_update_id","previous_status","shipment_id"],"type":"object"},"PackageStatusUpdateResponse":{"properties":{"data":{"$ref":"#/components/schemas/PackageStatusUpdateResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PackageStatusUpdateResult":{"properties":{"event":{"$ref":"#/components/schemas/FulfillmentEvent"},"fulfillment_notifications":{"items":{"$ref":"#/components/schemas/FulfillmentNotification"},"type":"array"},"package":{"$ref":"#/components/schemas/Package"},"package_status_update":{"$ref":"#/components/schemas/PackageStatusUpdate"},"unchanged":{"type":"boolean"}},"required":["package"],"type":"object"},"PackageTransitionRequest":{"discriminator":{"mapping":{"mark_delivered":"#/components/schemas/PackageTransitionRequestMarkDelivered","mark_delivery_attempted":"#/components/schemas/PackageTransitionRequestMarkDeliveryAttempted","mark_exception":"#/components/schemas/PackageTransitionRequestMarkException","mark_in_transit":"#/components/schemas/PackageTransitionRequestMarkInTransit","mark_out_for_delivery":"#/components/schemas/PackageTransitionRequestMarkOutForDelivery","mark_packed":"#/components/schemas/PackageTransitionRequestMarkPacked","mark_returned":"#/components/schemas/PackageTransitionRequestMarkReturned","mark_shipped":"#/components/schemas/PackageTransitionRequestMarkShipped"},"propertyName":"action"},"oneOf":[{"$ref":"#/components/schemas/PackageTransitionRequestMarkDelivered"},{"$ref":"#/components/schemas/PackageTransitionRequestMarkDeliveryAttempted"},{"$ref":"#/components/schemas/PackageTransitionRequestMarkException"},{"$ref":"#/components/schemas/PackageTransitionRequestMarkInTransit"},{"$ref":"#/components/schemas/PackageTransitionRequestMarkOutForDelivery"},{"$ref":"#/components/schemas/PackageTransitionRequestMarkPacked"},{"$ref":"#/components/schemas/PackageTransitionRequestMarkReturned"},{"$ref":"#/components/schemas/PackageTransitionRequestMarkShipped"}]},"PackageTransitionRequestMarkDelivered":{"additionalProperties":false,"properties":{"action":{"enum":["mark_delivered"],"type":"string","x-enum-descriptions":["Mark delivered."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"maxLength":500,"type":"string"}},"required":["action"],"type":"object"},"PackageTransitionRequestMarkDeliveryAttempted":{"additionalProperties":false,"properties":{"action":{"enum":["mark_delivery_attempted"],"type":"string","x-enum-descriptions":["Mark delivery attempted."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"maxLength":500,"type":"string"}},"required":["action"],"type":"object"},"PackageTransitionRequestMarkException":{"additionalProperties":false,"properties":{"action":{"enum":["mark_exception"],"type":"string","x-enum-descriptions":["Mark exception."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"maxLength":500,"type":"string"}},"required":["action"],"type":"object"},"PackageTransitionRequestMarkInTransit":{"additionalProperties":false,"properties":{"action":{"enum":["mark_in_transit"],"type":"string","x-enum-descriptions":["Mark in transit."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"maxLength":500,"type":"string"}},"required":["action"],"type":"object"},"PackageTransitionRequestMarkOutForDelivery":{"additionalProperties":false,"properties":{"action":{"enum":["mark_out_for_delivery"],"type":"string","x-enum-descriptions":["Mark out for delivery."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"maxLength":500,"type":"string"}},"required":["action"],"type":"object"},"PackageTransitionRequestMarkPacked":{"additionalProperties":false,"properties":{"action":{"enum":["mark_packed"],"type":"string","x-enum-descriptions":["Mark packed."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"maxLength":500,"type":"string"}},"required":["action"],"type":"object"},"PackageTransitionRequestMarkReturned":{"additionalProperties":false,"properties":{"action":{"enum":["mark_returned"],"type":"string","x-enum-descriptions":["Mark returned."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"maxLength":500,"type":"string"}},"required":["action"],"type":"object"},"PackageTransitionRequestMarkShipped":{"additionalProperties":false,"properties":{"action":{"enum":["mark_shipped"],"type":"string","x-enum-descriptions":["Mark shipped."],"x-flint-enum":"closed"},"buyer_notification_behavior":{"enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Resource version the caller last read.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"maxLength":500,"type":"string"}},"required":["action"],"type":"object"},"PartnerApp":{"properties":{"allowed_scopes":{"items":{"type":"string"},"readOnly":true,"type":"array"},"api_version":{"type":"string"},"api_version_changed_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"api_version_previous":{"readOnly":true,"type":"string"},"app_type":{"type":"string"},"client_id":{"readOnly":true,"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"default_requested_permissions":{"items":{"type":"string"},"type":"array"},"name":{"type":"string"},"partner_app_id":{"readOnly":true,"type":"string"},"permission_manifest":{"items":{"$ref":"#/components/schemas/PartnerAppPermissionManifestEntry"},"type":"array"},"redirect_uris":{"items":{"type":"string"},"type":"array"},"status":{"readOnly":true,"type":"string"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"visibility":{"type":"string"}},"required":["allowed_scopes","api_version","app_type","client_id","default_requested_permissions","name","partner_app_id","permission_manifest","redirect_uris","status","visibility"],"type":"object"},"PartnerAppInstall":{"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"environment_grants":{"items":{"$ref":"#/components/schemas/PartnerEnvironmentGrant"},"type":"array"},"granted_scopes":{"items":{"type":"string"},"type":"array"},"installed_by_user_id":{"type":"string"},"merchant_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"revoked_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"revoked_by_user_id":{"type":"string"},"status":{"type":"string"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["granted_scopes","merchant_id","partner_app_install_id","status"],"type":"object"},"PartnerAppInstallListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PartnerAppInstall"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PartnerAppInstallResponse":{"properties":{"data":{"$ref":"#/components/schemas/PartnerAppInstall"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PartnerAppListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PartnerApp"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PartnerAppPermissionManifestEntry":{"properties":{"description":{"type":"string"},"optional":{"type":"boolean"},"permission_id":{"type":"string"},"required_scopes":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"}},"required":["description","permission_id","required_scopes","title"],"type":"object"},"PartnerAppResponse":{"properties":{"data":{"$ref":"#/components/schemas/PartnerApp"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PartnerAppSecretRotationResult":{"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"partner_app_id":{"type":"string"}},"required":["client_id","client_secret","partner_app_id"],"type":"object"},"PartnerAppWithSecret":{"properties":{"allowed_scopes":{"items":{"type":"string"},"readOnly":true,"type":"array"},"api_version":{"type":"string"},"api_version_changed_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"api_version_previous":{"readOnly":true,"type":"string"},"app_type":{"type":"string"},"client_id":{"readOnly":true,"type":"string"},"client_secret":{"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"default_requested_permissions":{"items":{"type":"string"},"type":"array"},"name":{"type":"string"},"partner_app_id":{"readOnly":true,"type":"string"},"permission_manifest":{"items":{"$ref":"#/components/schemas/PartnerAppPermissionManifestEntry"},"type":"array"},"redirect_uris":{"items":{"type":"string"},"type":"array"},"status":{"readOnly":true,"type":"string"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"visibility":{"type":"string"}},"required":["allowed_scopes","api_version","app_type","client_id","client_secret","default_requested_permissions","name","partner_app_id","permission_manifest","redirect_uris","status","visibility"],"type":"object"},"PartnerAuthorizePreview":{"properties":{"app_type":{"type":"string"},"client_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"name":{"type":"string"},"partner_app_id":{"type":"string"},"redirect_uri":{"type":"string"},"requested_permission_ids":{"items":{"type":"string"},"type":"array"},"requested_permissions":{"items":{"$ref":"#/components/schemas/PartnerAuthorizePreviewPermission"},"type":"array"}},"required":["app_type","client_id","mode","name","partner_app_id","redirect_uri","requested_permission_ids","requested_permissions"],"type":"object"},"PartnerAuthorizePreviewPermission":{"properties":{"description":{"type":"string"},"optional":{"type":"boolean"},"permission_id":{"type":"string"},"title":{"type":"string"}},"required":["description","permission_id","title"],"type":"object"},"PartnerAuthorizePreviewResponse":{"properties":{"data":{"$ref":"#/components/schemas/PartnerAuthorizePreview"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PartnerEnvironmentGrant":{"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"granted_scopes":{"items":{"type":"string"},"type":"array"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"revoked_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"revoked_by_user_id":{"type":"string"},"status":{"type":"string"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["environment_grant_id","granted_scopes","mode","status"],"type":"object"},"PartnerEnvironmentGrantEventPayload":{"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"granted_scopes":{"items":{"type":"string"},"type":"array"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"revoked_by_user_id":{"type":"string"},"status":{"enum":["pending_exchange","active","revoked"],"type":"string","x-enum-descriptions":["Pending exchange.","Active.","Revoked."],"x-flint-enum":"open"}},"required":["environment_grant_id","granted_scopes","merchant_id","mode","partner_app_id","partner_app_install_id","status"],"type":"object"},"PartnerInstallEventPayload":{"properties":{"granted_scopes":{"items":{"type":"string"},"type":"array"},"installed_by_user_id":{"type":"string"},"merchant_id":{"type":"string"},"partner_app_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"revoked_by_user_id":{"type":"string"},"status":{"enum":["pending_exchange","pending_consent","pending_onboarding","active","pending_permission_upgrade","flagged_for_review","revoked","errored"],"type":"string","x-enum-descriptions":["Pending exchange.","Pending consent.","Pending onboarding.","Active.","Pending permission upgrade.","Flagged for review.","Revoked.","Errored."],"x-flint-enum":"open"}},"required":["granted_scopes","merchant_id","partner_app_id","partner_app_install_id","status"],"type":"object"},"PartnerTokenErrorResponse":{"properties":{"error":{"type":"string"},"error_description":{"type":"string"}},"required":["error"],"type":"object"},"PartnerTokenRequest":{"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"code":{"type":"string"},"grant_type":{"type":"string"},"redirect_uri":{"type":"string"},"refresh_token":{"type":"string"}},"required":["client_id","client_secret","grant_type"],"type":"object"},"PartnerTokenResponse":{"properties":{"access_token":{"type":"string"},"environment_grant_id":{"type":"string"},"expires_in":{"format":"int64","type":"integer"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"refresh_token":{"type":"string"},"scope":{"type":"string"},"token_type":{"type":"string"}},"required":["access_token","environment_grant_id","expires_in","merchant_id","mode","partner_app_id","partner_app_install_id","token_type"],"type":"object"},"PartnerWebhookEnvelope":{"properties":{"api_version":{"format":"date","type":"string"},"created_at":{"format":"date-time","type":"string"},"data":{"type":"object"},"event_type":{"enum":["balance.updated","balance_transaction.created","balance_transaction.updated","capability.updated","checkout_session.closed","checkout_session.completed","checkout_session.expired","checkout_session.invalidated","credit_note.allocation_created","credit_note.allocation_reversed","credit_note.created","credit_note.issued","credit_note.updated","credit_note.voided","customer.created","customer.deletion_completed","customer.deletion_rejected","customer.deletion_requested","customer.updated","delivery_location_set.activated","delivery_location_set.archived","delivery_location_set.created","delivery_location_set.deactivated","delivery_location_set.updated","delivery_method.activated","delivery_method.archived","delivery_method.created","delivery_method.deactivated","delivery_method.updated","delivery_profile.activated","delivery_profile.archived","delivery_profile.created","delivery_profile.deactivated","delivery_profile.updated","delivery_rate.archived","delivery_rate.created","delivery_rate.updated","delivery_rate_callback.activated","delivery_rate_callback.archived","delivery_rate_callback.created","delivery_rate_callback.deactivated","delivery_rate_callback.updated","delivery_revocation.created","delivery_selection.committed","delivery_zone.activated","delivery_zone.archived","delivery_zone.created","delivery_zone.deactivated","delivery_zone.updated","dispute.closed","dispute.created","dispute.lost","dispute.needs_response","dispute.prevented","dispute.updated","dispute.warning_closed","dispute.won","fraud_warning.created","fraud_warning.updated","inventory.action_required","inventory.count.applied","inventory.level.updated","inventory.receipt.created","inventory.reservation.at_risk","inventory.reservation.closed","inventory.reservation.committed","inventory.reservation.consumed","inventory.reservation.created","inventory.reservation.hold_expired","inventory.reservation.released","inventory.shortage.detected","inventory.transfer.closed","inventory.transfer.departed","inventory.transfer.lost","inventory.transfer.received","inventory.transfer.returned","invoice.collection_block_resolved","invoice.collection_blocked","invoice.created","invoice.credited","invoice.delivery_failed","invoice.delivery_succeeded","invoice.issue_failed","invoice.issued","invoice.late_fee_assessed","invoice.late_fee_due","invoice.late_fee_waived","invoice.manual_payment_recorded","invoice.manual_payment_reversed","invoice.marked_uncollectible","invoice.overdue","invoice.paid","invoice.partially_paid","invoice.partially_refunded","invoice.payment_attempt_canceled","invoice.payment_attempt_expired","invoice.payment_failed","invoice.payment_processing","invoice.refunded","invoice.reminder_due","invoice.sent","invoice.updated","invoice.voided","merchant.readiness.updated","merchant_billing_balance.updated","merchant_subscription_invoice.issued","merchant_subscription_invoice.updated","order.closed","order.created","order.fulfillment.completed","order.fulfillment.created","order.fulfillment.event.created","order.fulfillment.package.created","order.fulfillment.package.updated","order.fulfillment.shipment.created","order.fulfillment.shipment.updated","order.fulfillment.status_changed","order.fulfillment.updated","order.inventory_action_required","order.inventory_exception.created","order.inventory_exception.resolved","order.paid","order.partially_paid","order.payment_authorization_canceled","order.payment_authorization_expired","order.payment_authorized","order.payment_captured","order.refunded","order.updated","partner_app.install.created","partner_app.install.environment_grant.created","partner_app.install.environment_grant.revoked","partner_app.install.permissions_updated","partner_app.install.revoked","partner_app.install.updated","payment_intent.canceled","payment_intent.fulfillment_hold.updated","payment_intent.payment_failed","payment_intent.processing","payment_intent.requires_action","payment_intent.requires_capture","payment_intent.succeeded","payment_method.failed","payment_method.removed","payment_method.saved","payout.canceled","payout.created","payout.failed","payout.paid","payout.reversed","payout.updated","payout_destination.created","payout_destination.deleted","payout_destination.disabled","payout_destination.updated","payout_settings.updated","refund.created","refund.failed","refund.updated","report.failed","report.succeeded","return.canceled","return.completed","return.created","return.decision_recorded","return.reopened","return.updated","return_disposition.created","return_disposition.updated","return_inspection.acceptance_decided","return_inspection.created","return_inspection.superseded","return_receipt.created","return_receipt.superseded","return_receipt.verified","return_resolution.created","return_resolution.updated","review.closed","review.opened","subscription.activated","subscription.canceled","subscription.created","subscription.dunning_exhausted","subscription.past_due","subscription.paused","subscription.payment_failed","subscription.payment_succeeded","subscription.renewal_upcoming","subscription.resumed","subscription.trial_ending","subscription.updated"],"type":"string","x-enum-descriptions":["Balance.updated.","Balance transaction.created.","Balance transaction.updated.","Capability.updated.","Checkout session.closed.","Checkout session.completed.","Checkout session.expired.","Checkout session.invalidated.","Credit note.allocation created.","Credit note.allocation reversed.","Credit note.created.","Credit note.issued.","Credit note.updated.","Credit note.voided.","Customer.created.","Customer.deletion completed.","Customer.deletion rejected.","Customer.deletion requested.","Customer.updated.","Delivery location set.activated.","Delivery location set.archived.","Delivery location set.created.","Delivery location set.deactivated.","Delivery location set.updated.","Delivery method.activated.","Delivery method.archived.","Delivery method.created.","Delivery method.deactivated.","Delivery method.updated.","Delivery profile.activated.","Delivery profile.archived.","Delivery profile.created.","Delivery profile.deactivated.","Delivery profile.updated.","Delivery rate.archived.","Delivery rate.created.","Delivery rate.updated.","Delivery rate callback.activated.","Delivery rate callback.archived.","Delivery rate callback.created.","Delivery rate callback.deactivated.","Delivery rate callback.updated.","Delivery revocation.created.","Delivery selection.committed.","Delivery zone.activated.","Delivery zone.archived.","Delivery zone.created.","Delivery zone.deactivated.","Delivery zone.updated.","Dispute.closed.","Dispute.created.","Dispute.lost.","Dispute.needs response.","Dispute.prevented.","Dispute.updated.","Dispute.warning closed.","Dispute.won.","Fraud warning.created.","Fraud warning.updated.","Inventory.action required.","Inventory.count.applied.","Inventory.level.updated.","Inventory.receipt.created.","Inventory.reservation.at risk.","Inventory.reservation.closed.","Inventory.reservation.committed.","Inventory.reservation.consumed.","Inventory.reservation.created.","Inventory.reservation.hold expired.","Inventory.reservation.released.","Inventory.shortage.detected.","Inventory.transfer.closed.","Inventory.transfer.departed.","Inventory.transfer.lost.","Inventory.transfer.received.","Inventory.transfer.returned.","Invoice.collection block resolved.","Invoice.collection blocked.","Invoice.created.","Invoice.credited.","Invoice.delivery failed.","Invoice.delivery succeeded.","Invoice.issue failed.","Invoice.issued.","Invoice.late fee assessed.","Invoice.late fee due.","Invoice.late fee waived.","Invoice.manual payment recorded.","Invoice.manual payment reversed.","Invoice.marked uncollectible.","Invoice.overdue.","Invoice.paid.","Invoice.partially paid.","Invoice.partially refunded.","Invoice.payment attempt canceled.","Invoice.payment attempt expired.","Invoice.payment failed.","Invoice.payment processing.","Invoice.refunded.","Invoice.reminder due.","Invoice.sent.","Invoice.updated.","Invoice.voided.","Merchant.readiness.updated.","Merchant billing balance.updated.","Merchant subscription invoice.issued.","Merchant subscription invoice.updated.","Order.closed.","Order.created.","Order.fulfillment.completed.","Order.fulfillment.created.","Order.fulfillment.event.created.","Order.fulfillment.package.created.","Order.fulfillment.package.updated.","Order.fulfillment.shipment.created.","Order.fulfillment.shipment.updated.","Order.fulfillment.status changed.","Order.fulfillment.updated.","Order.inventory action required.","Order.inventory exception.created.","Order.inventory exception.resolved.","Order.paid.","Order.partially paid.","Order.payment authorization canceled.","Order.payment authorization expired.","Order.payment authorized.","Order.payment captured.","Order.refunded.","Order.updated.","Partner app.install.created.","Partner app.install.environment grant.created.","Partner app.install.environment grant.revoked.","Partner app.install.permissions updated.","Partner app.install.revoked.","Partner app.install.updated.","Payment intent.canceled.","Payment intent.fulfillment hold.updated.","Payment intent.payment failed.","Payment intent.processing.","Payment intent.requires action.","Payment intent.requires capture.","Payment intent.succeeded.","Payment method.failed.","Payment method.removed.","Payment method.saved.","Payout.canceled.","Payout.created.","Payout.failed.","Payout.paid.","Payout.reversed.","Payout.updated.","Payout destination.created.","Payout destination.deleted.","Payout destination.disabled.","Payout destination.updated.","Payout settings.updated.","Refund.created.","Refund.failed.","Refund.updated.","Report.failed.","Report.succeeded.","Return.canceled.","Return.completed.","Return.created.","Return.decision recorded.","Return.reopened.","Return.updated.","Return disposition.created.","Return disposition.updated.","Return inspection.acceptance decided.","Return inspection.created.","Return inspection.superseded.","Return receipt.created.","Return receipt.superseded.","Return receipt.verified.","Return resolution.created.","Return resolution.updated.","Review.closed.","Review.opened.","Subscription.activated.","Subscription.canceled.","Subscription.created.","Subscription.dunning exhausted.","Subscription.past due.","Subscription.paused.","Subscription.payment failed.","Subscription.payment succeeded.","Subscription.renewal upcoming.","Subscription.resumed.","Subscription.trial ending.","Subscription.updated."],"x-flint-enum":"closed"},"partner_app_id":{"type":"string"},"webhook_event_id":{"type":"string"}},"required":["webhook_event_id","event_type","partner_app_id","created_at","data","api_version"],"type":"object"},"PauseSubscriptionRequest":{"properties":{"pause_duration_cycles":{"format":"int32","type":"integer"}},"type":"object"},"PayOrderRequest":{"discriminator":{"mapping":{"confirm_payment_intents":"#/components/schemas/PayOrderRequestConfirmPaymentIntents","pay":"#/components/schemas/PayOrderRequestPay","resume":"#/components/schemas/PayOrderRequestResume","setup":"#/components/schemas/PayOrderRequestSetup"},"propertyName":"action"},"oneOf":[{"$ref":"#/components/schemas/PayOrderRequestPay"},{"$ref":"#/components/schemas/PayOrderRequestConfirmPaymentIntents"},{"$ref":"#/components/schemas/PayOrderRequestSetup"},{"$ref":"#/components/schemas/PayOrderRequestResume"}]},"PayOrderRequestConfirmPaymentIntents":{"additionalProperties":false,"properties":{"action":{"enum":["confirm_payment_intents"],"type":"string","x-enum-descriptions":["Confirm payment intents."],"x-flint-enum":"closed"},"buyer_email":{"type":"string"},"buyer_phone":{"type":"string"},"completion_behavior":{"enum":["complete_order","partial_payment"],"type":"string","x-enum-descriptions":["Complete order.","Partial payment."],"x-flint-enum":"closed"},"expected_outstanding_money":{"$ref":"#/components/schemas/Money"},"payment_intents":{"items":{"$ref":"#/components/schemas/OrderPaymentIntentSelection"},"minItems":1,"type":"array"}},"required":["action","payment_intents"],"type":"object"},"PayOrderRequestPay":{"additionalProperties":false,"properties":{"action":{"enum":["pay"],"type":"string","x-enum-descriptions":["Pay."],"x-flint-enum":"closed"},"buyer_email":{"type":"string"},"buyer_phone":{"type":"string"},"expected_outstanding_money":{"$ref":"#/components/schemas/Money"},"payment_source":{"$ref":"#/components/schemas/PaymentSourceCredential"}},"required":["action"],"type":"object"},"PayOrderRequestResume":{"additionalProperties":false,"properties":{"action":{"enum":["resume"],"type":"string","x-enum-descriptions":["Resume."],"x-flint-enum":"closed"},"buyer_email":{"type":"string"},"buyer_phone":{"type":"string"},"expected_outstanding_money":{"$ref":"#/components/schemas/Money"},"payment_attempt_id":{"minLength":1,"type":"string"}},"required":["action","payment_attempt_id"],"type":"object"},"PayOrderRequestSetup":{"additionalProperties":false,"properties":{"action":{"enum":["setup"],"type":"string","x-enum-descriptions":["Setup."],"x-flint-enum":"closed"},"buyer_email":{"type":"string"},"buyer_phone":{"type":"string"},"expected_outstanding_money":{"$ref":"#/components/schemas/Money"},"setup_payment_source":{"additionalProperties":false,"properties":{"token":{"minLength":1,"type":"string"}},"required":["token"],"type":"object"}},"required":["action","setup_payment_source"],"type":"object"},"PayOrderResponse":{"properties":{"data":{"$ref":"#/components/schemas/PayOrderResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PayOrderResult":{"properties":{"order":{"$ref":"#/components/schemas/Order"},"payment_attempt":{"$ref":"#/components/schemas/OrderPaymentAttempt"}},"required":["order"],"type":"object"},"PaymentAttemptPaymentIntent":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"last_payment_error":{"$ref":"#/components/schemas/PaymentErrorSummary"},"payment_intent_id":{"type":"string"},"status":{"enum":["requires_payment_method","requires_confirmation","requires_action","processing","requires_capture","canceled","succeeded","expired"],"type":"string","x-enum-descriptions":["Requires payment method.","Requires confirmation.","Requires action.","Processing.","Requires capture.","Canceled.","Succeeded.","Expired."],"x-flint-enum":"open"},"tip_money":{"$ref":"#/components/schemas/Money"}},"required":["amount_money","payment_intent_id","status","tip_money"],"type":"object"},"PaymentClientAction":{"description":"Typed provider-specific browser action payload. Execute the selected provider action before continuing the owning payment through Flint.","properties":{"stripe":{"$ref":"#/components/schemas/StripePaymentClientAction"}},"required":["stripe"],"type":"object"},"PaymentCollection":{"properties":{"stripe":{"$ref":"#/components/schemas/PaymentCollectionStripe"}},"type":"object"},"PaymentCollectionStripe":{"properties":{"account_id":{"type":"string"},"elements":{"$ref":"#/components/schemas/PaymentCollectionStripeElements"},"publishable_key":{"type":"string"},"return_url":{"type":"string"}},"type":"object"},"PaymentCollectionStripeElements":{"description":"Stripe Elements collection guidance. Follow next_step in the browser, then submit the result to submit_to through Flint.","properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"digital_wallets":{"items":{"type":"string"},"type":"array"},"mode":{"description":"Whether Elements is collecting a payment source for an immediate payment or a setup source for future use.","enum":["payment","setup"],"type":"string","x-enum-descriptions":["Payment.","Setup."],"x-flint-enum":"closed"},"next_step":{"description":"Browser collection operation to perform before calling submit_to.","enum":["collect_payment_source","collect_setup_payment_source","create_confirmation_token"],"type":"string","x-enum-descriptions":["Collect payment source.","Collect setup payment source.","Create confirmation token."],"x-flint-enum":"closed"},"payment_method_creation":{"description":"Stripe Elements payment method creation mode. Follow next_step: standalone PaymentIntents and checkout-authenticated order collection create a ConfirmationToken, while merchant-authenticated order collection and setup collection create a PaymentMethod.","enum":["manual"],"type":"string","x-enum-descriptions":["Manual."],"x-flint-enum":"closed"},"payment_method_options":{"additionalProperties":{"type":"string"},"type":"object"},"payment_method_types":{"items":{"type":"string"},"type":"array"},"selectable_payment_intents":{"items":{"$ref":"#/components/schemas/SelectableOrderPaymentIntent"},"type":"array"},"submit_to":{"description":"Flint operation that accepts the result of next_step.","enum":["pay_order","confirm_payment_intent"],"type":"string","x-enum-descriptions":["Pay order.","Confirm payment intent."],"x-flint-enum":"closed"}},"required":["mode","next_step","payment_method_creation","payment_method_types","submit_to"],"type":"object"},"PaymentErrorSummary":{"properties":{"code":{"description":"Flint-normalized payment failure code. Unknown provider values are returned as payment_failed.","enum":["card_declined","insufficient_funds","bank_account_closed","bank_account_not_found","bank_debit_not_authorized","bank_account_restricted","bank_debit_limit_exceeded","authentication_required","payment_blocked","expired_card","incorrect_cvc","processing_error","payment_method_unavailable","payment_method_declined","payment_not_completed","payment_action_expired","payment_method_temporarily_unavailable","payment_failed"],"type":"string","x-enum-descriptions":["Card declined.","Insufficient funds.","Bank account closed.","Bank account not found.","Bank debit not authorized.","Bank account restricted.","Bank debit limit exceeded.","Authentication required.","Payment blocked.","Expired card.","Incorrect cvc.","Processing error.","Payment method unavailable.","Payment method declined.","Payment not completed.","Payment action expired.","Payment method temporarily unavailable.","Payment failed."],"x-flint-enum":"closed"},"failed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"message":{"description":"Flint-authored merchant-facing payment failure message. This is stable explanatory text, not raw provider copy.","type":"string"},"remediation":{"$ref":"#/components/schemas/ErrorRemediation"}},"required":["code","message"],"type":"object"},"PaymentFulfillmentHold":{"properties":{"reason":{"enum":["external_payment_hold","external_payment_hold_released"],"type":"string","x-enum-descriptions":["External payment hold.","External payment hold released."],"x-flint-enum":"closed"},"released_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"requested_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"required_action":{"enum":["pause_fulfillment","reevaluate_fulfillment"],"type":"string","x-enum-descriptions":["Pause fulfillment.","Reevaluate fulfillment."],"x-flint-enum":"closed"},"status":{"enum":["active","released"],"type":"string","x-enum-descriptions":["Active.","Released."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["reason","requested_at","required_action","status","updated_at"],"type":"object"},"PaymentIntent":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"authorization_expires_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"authorized_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"authorized_money":{"$ref":"#/components/schemas/Money","readOnly":true},"cancellation_reason":{"description":"Flint-normalized reason the payment intent was canceled. Unknown processor values are returned as payment_canceled.","enum":["requested_by_customer","duplicate","fraudulent","abandoned","authorization_expired","invoice_payment_failed","invoice_voided","payment_canceled"],"readOnly":true,"type":"string","x-enum-descriptions":["Requested by customer.","Duplicate.","Fraudulent.","Abandoned.","Authorization expired.","Invoice payment failed.","Invoice voided.","Payment canceled."],"x-flint-enum":"closed"},"capturable_money":{"$ref":"#/components/schemas/Money","readOnly":true},"capture_method":{"enum":["automatic","manual"],"type":"string","x-enum-descriptions":["Automatic.","Manual."],"x-flint-enum":"closed"},"captured_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"captured_money":{"$ref":"#/components/schemas/Money","readOnly":true},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"current_payment_action":{"$ref":"#/components/schemas/PendingPaymentAction","description":"Typed browser authority for the current standalone payment action. Complete it, then call the same confirm endpoint without a replacement credential. Absent when no browser action is required.","readOnly":true},"customer":{"anyOf":[{"$ref":"#/components/schemas/ExpandedCustomerSummary"},{"type":"null"}],"readOnly":true},"customer_id":{"type":"string"},"dispute_status":{"enum":["none","warning_needs_response","warning_under_review","warning_closed","needs_response","under_review","won","lost","prevented"],"readOnly":true,"type":"string","x-enum-descriptions":["None.","Warning needs response.","Warning under review.","Warning closed.","Needs response.","Under review.","Won.","Lost.","Prevented."],"x-flint-enum":"open"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"fulfillment_hold":{"$ref":"#/components/schemas/PaymentFulfillmentHold","readOnly":true},"invoice":{"anyOf":[{"$ref":"#/components/schemas/ExpandedInvoiceSummary"},{"type":"null"}],"readOnly":true},"invoice_id":{"readOnly":true,"type":"string"},"last_payment_error":{"anyOf":[{"$ref":"#/components/schemas/PaymentErrorSummary"},{"type":"null"}],"readOnly":true},"merchant_id":{"readOnly":true,"type":"string"},"merchant_net_money":{"$ref":"#/components/schemas/Money","description":"Captured amount minus processing_fee_money. Later merchant assessments and credits are separate balance effects.","readOnly":true},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrderSummary"},{"type":"null"}],"readOnly":true},"order_id":{"readOnly":true,"type":"string"},"origin":{"enum":["virtual_terminal","payment_link","checkout","api","subscription"],"readOnly":true,"type":"string","x-enum-descriptions":["Virtual terminal.","Payment link.","Checkout.","Api.","Subscription."],"x-flint-enum":"closed"},"payment_flow":{"enum":["checkout","payment_link","invoice","subscription_initial","subscription_renewal","virtual_terminal","api"],"readOnly":true,"type":"string","x-enum-descriptions":["Checkout.","Payment link.","Invoice.","Subscription initial.","Subscription renewal.","Virtual terminal.","Api."],"x-flint-enum":"closed"},"payment_intent_id":{"readOnly":true,"type":"string"},"payment_options":{"items":{"enum":["card","apple_pay","google_pay","affirm","ach_debit"],"type":"string","x-enum-descriptions":["Card.","Apple pay.","Google pay.","Affirm.","Ach debit."],"x-flint-enum":"closed"},"type":"array"},"payment_source":{"$ref":"#/components/schemas/PaymentSourceSummary","readOnly":true},"processing_fee_money":{"$ref":"#/components/schemas/Money","description":"Flint's all-in processing fee for this payment. It is the complete price Flint charges to process the payment, never a provider cost passed through. The fee is final once the card payment is captured or the ACH payment succeeds; canceled payments and failures before success have none. Your net for the payment is captured_money minus this fee. Refunds do not return or revise it.","readOnly":true},"receipt_email":{"type":"string"},"refund_status":{"enum":["none","partially_refunded","refunded"],"readOnly":true,"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"refunded_money":{"$ref":"#/components/schemas/Money","readOnly":true},"released_money":{"$ref":"#/components/schemas/Money","readOnly":true},"risk":{"anyOf":[{"$ref":"#/components/schemas/PaymentRisk"},{"type":"null"}],"readOnly":true},"selected_payment_option":{"readOnly":true,"type":"string"},"settlement_status":{"enum":["none","partially_refunded","refunded","disputed"],"readOnly":true,"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded.","Disputed."],"x-flint-enum":"open"},"status":{"enum":["requires_payment_method","requires_confirmation","requires_action","processing","requires_capture","canceled","succeeded","expired"],"readOnly":true,"type":"string","x-enum-descriptions":["Requires payment method.","Requires confirmation.","Requires action.","Processing.","Requires capture.","Canceled.","Succeeded.","Expired."],"x-flint-enum":"open"},"support_reference":{"description":"Opaque payment reference to share with merchant support. Do not parse its format.","readOnly":true,"type":"string"},"tip_money":{"$ref":"#/components/schemas/Money"},"transaction_purpose":{"enum":["goods","services","other"],"type":"string","x-enum-descriptions":["Goods.","Services.","Other."],"x-flint-enum":"closed"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"}},"required":["amount_money","payment_flow","payment_intent_id","payment_options","status","support_reference","risk","last_payment_error"],"type":"object"},"PaymentIntentListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PaymentIntent"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PaymentIntentResponse":{"properties":{"data":{"$ref":"#/components/schemas/PaymentIntent"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PaymentLimitSettings":{"description":"Optional merchant limits that can lower Flint's payment-option and surface policy limits.","properties":{"max_amounts":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"description":"Maximum USD amounts keyed by default, surface, or an exact payment_option.surface selector. Merchant settings cannot raise Flint's policy ceiling.","type":"object"},"min_amounts":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"description":"Minimum USD amounts keyed by default, surface, or an exact payment_option.surface selector. Merchant settings cannot lower Flint's payment-option floor.","type":"object"}},"type":"object"},"PaymentLink":{"properties":{"completed_count":{"format":"int32","readOnly":true,"type":"integer"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"custom_fields":{"items":{"$ref":"#/components/schemas/PaymentLinkCustomField"},"type":"array"},"custom_text":{"$ref":"#/components/schemas/CheckoutCustomTextConfig"},"customer_collection":{"$ref":"#/components/schemas/PaymentLinkCustomerConfig"},"delivery_method_ids":{"items":{"type":"string"},"readOnly":true,"type":"array"},"description":{"type":"string"},"donation_max_amount_money":{"$ref":"#/components/schemas/Money"},"donation_min_amount_money":{"$ref":"#/components/schemas/Money"},"donation_suggested_amount_money_options":{"items":{"$ref":"#/components/schemas/Money"},"type":"array"},"event_config":{"$ref":"#/components/schemas/PaymentLinkEventConfig"},"expiration":{"$ref":"#/components/schemas/CheckoutExpirationConfig"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"image":{"$ref":"#/components/schemas/Image"},"inactive_message":{"type":"string"},"inventory_routing_source":{"$ref":"#/components/schemas/InventoryRoutingSourceInput"},"legal":{"$ref":"#/components/schemas/CheckoutLegalConfig"},"line_items":{"items":{"$ref":"#/components/schemas/PaymentLinkLineItem"},"type":"array"},"max_completions":{"format":"int32","type":"integer"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"payment_link_id":{"readOnly":true,"type":"string"},"payment_link_type":{"enum":["standard","donation","event"],"type":"string","x-enum-descriptions":["Standard.","Donation.","Event."],"x-flint-enum":"closed"},"payments":{"$ref":"#/components/schemas/CheckoutPaymentConfig"},"plan_id":{"type":"string"},"promotion_config":{"$ref":"#/components/schemas/CheckoutPromotionConfig"},"redirects":{"$ref":"#/components/schemas/CheckoutRedirectsConfig"},"status":{"enum":["active","inactive"],"readOnly":true,"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"subscription_plan":{"anyOf":[{"$ref":"#/components/schemas/ExpandedSubscriptionPlanSummary"},{"type":"null"}],"readOnly":true},"tax":{"$ref":"#/components/schemas/CheckoutTaxConfig"},"theme":{"$ref":"#/components/schemas/ThemeConfig"},"tip":{"$ref":"#/components/schemas/CheckoutTipConfig"},"total_quantity_sold":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","readOnly":true,"type":"integer"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"url":{"readOnly":true,"type":"string"},"version":{"format":"int64","readOnly":true,"type":"integer"}},"required":["completed_count","name","payment_link_id","status","url","version"],"type":"object"},"PaymentLinkCustomField":{"properties":{"custom_field_type":{"enum":["text","dropdown","checkbox","textarea"],"type":"string","x-enum-descriptions":["Text.","Dropdown.","Checkbox.","Textarea."],"x-flint-enum":"closed"},"key":{"type":"string"},"label":{"type":"string"},"max_length":{"format":"int32","type":"integer"},"options":{"items":{"type":"string"},"type":"array"},"payment_link_custom_field_id":{"readOnly":true,"type":"string"},"placeholder":{"type":"string"},"position":{"format":"int32","type":"integer"},"required":{"type":"boolean"}},"required":["custom_field_type","key","label","payment_link_custom_field_id"],"type":"object"},"PaymentLinkCustomFieldInput":{"properties":{"custom_field_type":{"enum":["text","dropdown","checkbox","textarea"],"type":"string","x-enum-descriptions":["Text.","Dropdown.","Checkbox.","Textarea."],"x-flint-enum":"closed"},"key":{"type":"string"},"label":{"type":"string"},"max_length":{"format":"int32","type":"integer"},"options":{"items":{"type":"string"},"type":"array"},"placeholder":{"type":"string"},"position":{"format":"int32","type":"integer"},"required":{"type":"boolean"}},"required":["custom_field_type","key","label"],"type":"object"},"PaymentLinkCustomFieldPatchInput":{"properties":{"custom_field_type":{"enum":["text","dropdown","checkbox","textarea"],"type":"string","x-enum-descriptions":["Text.","Dropdown.","Checkbox.","Textarea."],"x-flint-enum":"closed"},"key":{"type":"string"},"label":{"type":"string"},"max_length":{"format":"int32","type":"integer"},"options":{"items":{"type":"string"},"type":"array"},"payment_link_custom_field_id":{"description":"Stable ID of an existing custom field. Omit it to create a new custom field.","type":"string"},"placeholder":{"type":"string"},"position":{"format":"int32","type":"integer"},"required":{"type":"boolean"}},"required":["custom_field_type","key","label"],"type":"object"},"PaymentLinkCustomerConfig":{"properties":{"enable_address_autocomplete":{"type":"boolean"},"require_email":{"type":"boolean"}},"type":"object"},"PaymentLinkEventConfig":{"properties":{"event_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"max_total_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","type":"integer"},"send_ticket_emails":{"type":"boolean"},"ticket_prefix":{"type":"string"},"venue":{"type":"string"}},"type":"object"},"PaymentLinkLineItem":{"oneOf":[{"not":{"anyOf":[{"required":["bundle_id"]},{"required":["name"]},{"required":["unit_price_money"]},{"required":["description"]},{"required":["tax"]},{"required":["allow_unit_price_adjustment"]},{"required":["min_unit_price_money"]},{"required":["max_unit_price_money"]},{"required":["suggested_unit_price_money_options"]}]},"required":["variant_id"]},{"not":{"anyOf":[{"required":["variant_id"]},{"required":["name"]},{"required":["unit_price_money"]},{"required":["description"]},{"required":["tax"]},{"required":["allow_unit_price_adjustment"]},{"required":["min_unit_price_money"]},{"required":["max_unit_price_money"]},{"required":["suggested_unit_price_money_options"]}]},"required":["bundle_id"]},{"not":{"anyOf":[{"required":["variant_id"]},{"required":["bundle_id"]}]},"required":["name","unit_price_money"]},{"not":{"anyOf":[{"required":["variant_id"]},{"required":["bundle_id"]}]},"properties":{"allow_unit_price_adjustment":{"enum":[true],"type":"boolean","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"required":["name","allow_unit_price_adjustment"]}],"properties":{"allow_quantity_adjustment":{"type":"boolean"},"allow_unit_price_adjustment":{"type":"boolean"},"bundle_id":{"type":"string"},"description":{"type":"string"},"is_catalog_item_unavailable":{"description":"True when this line item references a variant or bundle that is missing, deleted, or inactive, so it cannot be sold right now. Always false on ad-hoc line items.","readOnly":true,"type":"boolean"},"key":{"type":"string"},"max_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","type":"integer"},"max_unit_price_money":{"$ref":"#/components/schemas/Money"},"min_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","type":"integer"},"min_unit_price_money":{"$ref":"#/components/schemas/Money"},"name":{"type":"string"},"payment_link_line_item_id":{"readOnly":true,"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","type":"integer"},"resolved_name":{"description":"Current catalog name of the referenced variant or bundle. A variant reads as the product name, plus the variant name when the variant is a named option combination. This is the catalog value at read time, not a stored snapshot: checkout resolves it again when a buyer opens the link. Absent on ad-hoc line items and when the catalog object no longer exists.","readOnly":true,"type":"string"},"resolved_unit_price_money":{"$ref":"#/components/schemas/Money","description":"Current catalog unit price of the referenced variant or bundle. This is the catalog value at read time, not a stored snapshot: checkout resolves the price again when a buyer opens the link, so the amount a buyer pays can differ. Absent on ad-hoc line items and when the catalog object no longer exists.","readOnly":true},"suggested_unit_price_money_options":{"items":{"$ref":"#/components/schemas/Money"},"type":"array"},"tax":{"$ref":"#/components/schemas/OrderLineItemTax"},"unit_price_money":{"$ref":"#/components/schemas/Money"},"variant_id":{"type":"string"}},"required":["is_catalog_item_unavailable","payment_link_line_item_id","quantity"],"type":"object"},"PaymentLinkLineItemInput":{"oneOf":[{"not":{"anyOf":[{"required":["bundle_id"]},{"required":["name"]},{"required":["unit_price_money"]},{"required":["description"]},{"required":["tax"]},{"required":["allow_unit_price_adjustment"]},{"required":["min_unit_price_money"]},{"required":["max_unit_price_money"]},{"required":["suggested_unit_price_money_options"]}]},"required":["variant_id"]},{"not":{"anyOf":[{"required":["variant_id"]},{"required":["name"]},{"required":["unit_price_money"]},{"required":["description"]},{"required":["tax"]},{"required":["allow_unit_price_adjustment"]},{"required":["min_unit_price_money"]},{"required":["max_unit_price_money"]},{"required":["suggested_unit_price_money_options"]}]},"required":["bundle_id"]},{"not":{"anyOf":[{"required":["variant_id"]},{"required":["bundle_id"]}]},"required":["name","unit_price_money"]},{"not":{"anyOf":[{"required":["variant_id"]},{"required":["bundle_id"]}]},"properties":{"allow_unit_price_adjustment":{"enum":[true],"type":"boolean","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"required":["name","allow_unit_price_adjustment"]}],"properties":{"allow_quantity_adjustment":{"type":"boolean"},"allow_unit_price_adjustment":{"type":"boolean"},"bundle_id":{"type":"string"},"description":{"type":"string"},"key":{"type":"string"},"max_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","type":"integer"},"max_unit_price_money":{"$ref":"#/components/schemas/Money"},"min_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","type":"integer"},"min_unit_price_money":{"$ref":"#/components/schemas/Money"},"name":{"type":"string"},"quantity":{"default":1,"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","type":"integer"},"suggested_unit_price_money_options":{"items":{"$ref":"#/components/schemas/Money"},"type":"array"},"tax":{"$ref":"#/components/schemas/OrderLineItemTax"},"unit_price_money":{"$ref":"#/components/schemas/Money"},"variant_id":{"type":"string"}},"type":"object"},"PaymentLinkLineItemPatchInput":{"oneOf":[{"not":{"anyOf":[{"required":["bundle_id"]},{"required":["name"]},{"required":["unit_price_money"]},{"required":["description"]},{"required":["tax"]},{"required":["allow_unit_price_adjustment"]},{"required":["min_unit_price_money"]},{"required":["max_unit_price_money"]},{"required":["suggested_unit_price_money_options"]}]},"required":["variant_id"]},{"not":{"anyOf":[{"required":["variant_id"]},{"required":["name"]},{"required":["unit_price_money"]},{"required":["description"]},{"required":["tax"]},{"required":["allow_unit_price_adjustment"]},{"required":["min_unit_price_money"]},{"required":["max_unit_price_money"]},{"required":["suggested_unit_price_money_options"]}]},"required":["bundle_id"]},{"not":{"anyOf":[{"required":["variant_id"]},{"required":["bundle_id"]}]},"required":["name","unit_price_money"]},{"not":{"anyOf":[{"required":["variant_id"]},{"required":["bundle_id"]}]},"properties":{"allow_unit_price_adjustment":{"enum":[true],"type":"boolean","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"required":["name","allow_unit_price_adjustment"]}],"properties":{"allow_quantity_adjustment":{"type":"boolean"},"allow_unit_price_adjustment":{"type":"boolean"},"bundle_id":{"type":"string"},"description":{"type":"string"},"key":{"type":"string"},"max_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","type":"integer"},"max_unit_price_money":{"$ref":"#/components/schemas/Money"},"min_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","type":"integer"},"min_unit_price_money":{"$ref":"#/components/schemas/Money"},"name":{"type":"string"},"payment_link_line_item_id":{"description":"Stable ID of an existing line item. Omit it to create a new line item.","type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","type":"integer"},"suggested_unit_price_money_options":{"items":{"$ref":"#/components/schemas/Money"},"type":"array"},"tax":{"$ref":"#/components/schemas/OrderLineItemTax"},"unit_price_money":{"$ref":"#/components/schemas/Money"},"variant_id":{"type":"string"}},"required":["quantity"],"type":"object"},"PaymentLinkListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PaymentLink"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PaymentLinkResponse":{"properties":{"data":{"$ref":"#/components/schemas/PaymentLink"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PaymentLinkSubscriptionPreview":{"description":"Subscription terms shown before an active plan-backed payment link creates a checkout session.","properties":{"billing_interval":{"enum":["daily","weekly","monthly","yearly"],"type":"string","x-enum-descriptions":["Daily.","Weekly.","Monthly.","Yearly."],"x-flint-enum":"closed"},"billing_interval_count":{"description":"Number of billing intervals between recurring charges.","format":"int32","type":"integer"},"contract_term_months":{"description":"Minimum contract term in months, when configured.","format":"int32","type":"integer"},"early_termination_fee_money":{"$ref":"#/components/schemas/Money","description":"Early termination fee, when configured."},"plan_image":{"$ref":"#/components/schemas/Image","description":"Plan image shown to the buyer, when configured."},"plan_name":{"description":"Plan name shown to the buyer.","type":"string"},"recurring_total_money":{"$ref":"#/components/schemas/Money","description":"Recurring total for one billing interval, including line quantities and resolved modifiers."},"setup_fee_money":{"$ref":"#/components/schemas/Money","description":"Setup fee added to the first amount due, when configured."},"trial_period_days":{"description":"Number of trial days before the first recurring charge, when configured.","format":"int32","type":"integer"}},"required":["billing_interval","billing_interval_count","plan_name","recurring_total_money"],"type":"object"},"PaymentMethod":{"properties":{"card":{"$ref":"#/components/schemas/CardDetails","readOnly":true},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"customer":{"anyOf":[{"$ref":"#/components/schemas/ExpandedCustomerSummary"},{"type":"null"}],"readOnly":true},"customer_id":{"type":"string"},"merchant_id":{"readOnly":true,"type":"string"},"payment_method_id":{"readOnly":true,"type":"string"},"status":{"enum":["pending","active","expired","removed","failed"],"readOnly":true,"type":"string","x-enum-descriptions":["Pending.","Active.","Expired.","Removed.","Failed."],"x-flint-enum":"open"},"type":{"enum":["card"],"type":"string","x-enum-descriptions":["Card."],"x-flint-enum":"closed"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"}},"required":["customer_id","payment_method_id","status","type"],"type":"object"},"PaymentMethodDomain":{"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"domain_name":{"type":"string"},"payment_method_domain_id":{"readOnly":true,"type":"string"},"payment_options":{"items":{"$ref":"#/components/schemas/PaymentMethodDomainPaymentOption"},"readOnly":true,"type":"array"},"status":{"enum":["active","inactive"],"readOnly":true,"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"validation_status":{"enum":["active","action_required","unavailable"],"readOnly":true,"type":"string","x-enum-descriptions":["Active.","Action required.","Unavailable."],"x-flint-enum":"open"}},"required":["created_at","domain_name","payment_method_domain_id","payment_options","status","updated_at","validation_status"],"type":"object"},"PaymentMethodDomainListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PaymentMethodDomain"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PaymentMethodDomainPaymentOption":{"properties":{"payment_option":{"enum":["apple_pay","google_pay"],"type":"string","x-enum-descriptions":["Apple pay.","Google pay."],"x-flint-enum":"closed"},"status":{"enum":["active","inactive","unavailable"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Unavailable."],"x-flint-enum":"open"}},"required":["payment_option","status"],"type":"object"},"PaymentMethodDomainResponse":{"properties":{"data":{"$ref":"#/components/schemas/PaymentMethodDomain"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PaymentMethodListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PaymentMethod"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PaymentMethodResponse":{"properties":{"data":{"$ref":"#/components/schemas/PaymentMethod"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PaymentRefund":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"failure_reason":{"description":"Flint-normalized refund failure reason. Unknown provider values are returned as refund_failed.","enum":["expired_or_canceled_card","lost_or_stolen_card","insufficient_funds","insufficient_available_balance","declined","merchant_request","payment_disputed","payment_refund_failed","refund_failed"],"readOnly":true,"type":"string","x-enum-descriptions":["Expired or canceled card.","Lost or stolen card.","Insufficient funds.","Insufficient available balance.","Declined.","Merchant request.","Payment disputed.","Payment refund failed.","Refund failed."],"x-flint-enum":"closed"},"payment_intent":{"anyOf":[{"$ref":"#/components/schemas/ExpandedPaymentIntentSummary"},{"type":"null"}]},"payment_intent_id":{"type":"string"},"refunded_tip_money":{"$ref":"#/components/schemas/Money"},"status":{"enum":["pending","in_transit","succeeded","failed","requires_action","canceled","partially_succeeded"],"type":"string","x-enum-descriptions":["Pending.","In transit.","Succeeded.","Failed.","Requires action.","Canceled.","Partially succeeded."],"x-flint-enum":"open"}},"required":["amount_money","refunded_tip_money","status"],"type":"object"},"PaymentRisk":{"properties":{"evaluated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"level":{"enum":["normal","elevated","highest","not_assessed"],"type":"string","x-enum-descriptions":["Normal.","Elevated.","Highest.","Not assessed."],"x-flint-enum":"closed"},"matched_risk_rule_id":{"type":"string"},"outcome":{"enum":["authorized","manual_review","blocked","issuer_declined","invalid",null],"type":["string","null"],"x-enum-descriptions":["Authorized.","Manual review.","Blocked.","Issuer declined.","Invalid.","Null."],"x-flint-enum":"closed"},"outcome_reason":{"enum":["highest_risk","elevated_risk","low_authorization_probability","risk_rule","risk_policy",null],"type":["string","null"],"x-enum-descriptions":["Highest risk.","Elevated risk.","Low authorization probability.","Risk rule.","Risk policy.","Null."],"x-flint-enum":"closed"},"review_id":{"type":"string"},"score":{"format":"int32","type":"integer"},"statement":{"type":"string"}},"required":["evaluated_at","level","statement"],"type":"object"},"PaymentSourceAchDebitSummary":{"properties":{"account_type":{"enum":["checking","savings","other"],"type":"string","x-enum-descriptions":["Checking.","Savings.","Other."],"x-flint-enum":"closed"},"bank_name":{"type":"string"},"last4":{"type":"string"}},"type":"object"},"PaymentSourceCardSummary":{"properties":{"brand":{"enum":["visa","mastercard","amex","discover","diners","jcb","unionpay"],"type":"string","x-enum-descriptions":["Visa.","Mastercard.","Amex.","Discover.","Diners.","Jcb.","Unionpay."],"x-flint-enum":"closed"},"last4":{"type":"string"},"payment_method_id":{"type":"string"}},"type":"object"},"PaymentSourceCredential":{"properties":{"confirmation_token":{"type":"string"},"payment_method_id":{"type":"string"},"token":{"type":"string"}},"type":"object"},"PaymentSourceSummary":{"properties":{"ach_debit":{"$ref":"#/components/schemas/PaymentSourceAchDebitSummary"},"card":{"$ref":"#/components/schemas/PaymentSourceCardSummary"},"type":{"description":"Funding-method family. Wallet payment options use card because their underlying funding source is a card.","enum":["card","ach_debit","affirm"],"type":"string","x-enum-descriptions":["Card.","Ach debit.","Affirm."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"PaymentVolumeBucket":{"properties":{"label":{"type":"string"},"payments_count":{"$ref":"#/components/schemas/CountMetric"},"period_end":{"type":"string"},"period_start":{"type":"string"},"previous_volume_money":{"$ref":"#/components/schemas/Money"},"volume_money":{"$ref":"#/components/schemas/Money"}},"required":["label","payments_count","volume_money"],"type":"object"},"PaymentVolumeTimeseries":{"properties":{"buckets":{"items":{"$ref":"#/components/schemas/PaymentVolumeBucket"},"type":"array"},"currencies":{"items":{"type":"string"},"type":"array"},"has_multiple_currencies":{"type":"boolean"},"range":{"enum":["today","last_7_days","last_30_days"],"type":"string","x-enum-descriptions":["Today.","Last 7 days.","Last 30 days."],"x-flint-enum":"closed"},"timezone":{"type":"string"}},"required":["buckets","has_multiple_currencies","range","timezone"],"type":"object"},"PaymentVolumeTimeseriesResponse":{"properties":{"data":{"$ref":"#/components/schemas/PaymentVolumeTimeseries"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"Payout":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"arrival_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"balance_source_type":{"enum":["card","bank_account","fpx"],"type":"string","x-enum-descriptions":["Card.","Bank account.","Fpx."],"x-flint-enum":"closed"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"currency":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","readOnly":true,"type":"string"},"description":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"failure_code":{"description":"Flint-normalized payout failure code. Unknown provider values are returned as payout_failed.","enum":["account_closed","account_frozen","bank_account_restricted","bank_ownership_changed","could_not_process","debit_not_authorized","declined","insufficient_funds","invalid_account_number","incorrect_account_holder_name","incorrect_account_holder_address","incorrect_account_holder_tax_id","invalid_currency","no_account","unsupported_card","payout_failed"],"readOnly":true,"type":"string","x-enum-descriptions":["Account closed.","Account frozen.","Bank account restricted.","Bank ownership changed.","Could not process.","Debit not authorized.","Declined.","Insufficient funds.","Invalid account number.","Incorrect account holder name.","Incorrect account holder address.","Incorrect account holder tax id.","Invalid currency.","No account.","Unsupported card.","Payout failed."],"x-flint-enum":"closed"},"failure_message":{"description":"Flint-authored payout failure message. This is stable explanatory text, not a raw provider message.","readOnly":true,"type":"string"},"fee_amount_status":{"enum":["estimated","final","not_applicable"],"readOnly":true,"type":"string","x-enum-descriptions":["Estimated.","Final.","Not applicable."],"x-flint-enum":"open"},"fee_money":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}],"readOnly":true},"held_money":{"$ref":"#/components/schemas/Money","readOnly":true},"initiated_by":{"readOnly":true,"type":"string"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"method":{"enum":["standard"],"type":"string","x-enum-descriptions":["Standard."],"x-flint-enum":"closed"},"net_money":{"anyOf":[{"$ref":"#/components/schemas/SignedMoney"},{"type":"null"}],"readOnly":true},"original_payout":{"anyOf":[{"$ref":"#/components/schemas/ExpandedPayoutSummary"},{"type":"null"}],"readOnly":true},"original_payout_id":{"readOnly":true,"type":"string"},"payout_destination":{"anyOf":[{"$ref":"#/components/schemas/ExpandedPayoutDestinationSummary"},{"type":"null"}],"readOnly":true},"payout_destination_id":{"type":"string"},"payout_id":{"readOnly":true,"type":"string"},"reversal_status":{"enum":["none","reversing","reversed"],"readOnly":true,"type":"string","x-enum-descriptions":["None.","Reversing.","Reversed."],"x-flint-enum":"open"},"reversed_by_payout":{"anyOf":[{"$ref":"#/components/schemas/ExpandedPayoutSummary"},{"type":"null"}],"readOnly":true},"reversed_by_payout_id":{"readOnly":true,"type":"string"},"statement_descriptor":{"type":"string"},"status":{"enum":["pending","in_transit","paid","failed","canceled"],"readOnly":true,"type":"string","x-enum-descriptions":["Pending.","In transit.","Paid.","Failed.","Canceled."],"x-flint-enum":"open"},"trace_id":{"$ref":"#/components/schemas/PayoutTraceID","readOnly":true},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"}},"required":["amount_money","created_at","currency","fee_amount_status","held_money","initiated_by","merchant_id","method","payout_id","reversal_status","status","updated_at"],"type":"object"},"PayoutDestination":{"properties":{"available_payout_methods":{"items":{"enum":["standard"],"type":"string","x-enum-descriptions":["Standard."],"x-flint-enum":"closed"},"readOnly":true,"type":"array"},"bank_name":{"readOnly":true,"type":"string"},"country":{"description":"ISO 3166-1 alpha-2 country code.","example":"US","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","readOnly":true,"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"currency":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","readOnly":true,"type":"string"},"default_for_currency":{"readOnly":true,"type":"boolean"},"disabled_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"disabled_reason":{"description":"Flint-normalized reason the payout destination cannot currently be used. Unknown provider/backend values are returned as destination_unavailable.","enum":["destination_disabled","destination_removed","destination_unavailable","destination_rejected","destination_under_review","disabled_by_merchant_request","requirements_past_due","requirements_pending_verification","superseded_destination_session_completed"],"readOnly":true,"type":"string","x-enum-descriptions":["Destination disabled.","Destination removed.","Destination unavailable.","Destination rejected.","Destination under review.","Disabled by merchant request.","Requirements past due.","Requirements pending verification.","Superseded destination session completed."],"x-flint-enum":"closed"},"last4":{"readOnly":true,"type":"string"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"payout_destination_id":{"readOnly":true,"type":"string"},"status":{"enum":["pending","active","verification_required","disabled","deleted","failed"],"readOnly":true,"type":"string","x-enum-descriptions":["Pending.","Active.","Verification required.","Disabled.","Deleted.","Failed."],"x-flint-enum":"open"},"status_updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"type":{"enum":["bank_account","debit_card"],"readOnly":true,"type":"string","x-enum-descriptions":["Bank account.","Debit card."],"x-flint-enum":"closed"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"}},"required":["available_payout_methods","created_at","currency","default_for_currency","merchant_id","payout_destination_id","status","type","updated_at"],"type":"object"},"PayoutDestinationListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PayoutDestination"},"type":"array"},"meta":{"$ref":"#/components/schemas/MoneyMovementListMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PayoutDestinationResponse":{"properties":{"data":{"$ref":"#/components/schemas/PayoutDestination"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PayoutEntry":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money","readOnly":true},"balance_transaction_id":{"readOnly":true,"type":"string"},"occurred_at":{"description":"The balance transaction occurrence instant.","format":"date-time","readOnly":true,"type":"string"},"payout_entry_id":{"readOnly":true,"type":"string"},"type":{"enum":["payment","refund","dispute","dispute_reversal","return","recovery","payout","payout_failure","payout_cancellation","payout_reversal","payout_advance","payout_advance_funding","reserve_hold","reserve_release","payout_hold","payout_hold_release","adjustment","merchant_billing_payment","merchant_billing_payment_reversal"],"readOnly":true,"type":"string","x-enum-descriptions":["Payment.","Refund.","Dispute.","Dispute reversal.","Return.","Recovery.","Payout.","Payout failure.","Payout cancellation.","Payout reversal.","Payout advance.","Payout advance funding.","Reserve hold.","Reserve release.","Payout hold.","Payout hold release.","Adjustment.","Merchant billing payment.","Merchant billing payment reversal."],"x-flint-enum":"closed"}},"required":["amount_money","balance_transaction_id","occurred_at","payout_entry_id","type"],"type":"object"},"PayoutEntryListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PayoutEntry"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PayoutListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Payout"},"type":"array"},"meta":{"$ref":"#/components/schemas/MoneyMovementListMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PayoutResponse":{"properties":{"data":{"$ref":"#/components/schemas/Payout"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PayoutSettings":{"properties":{"blocked_reasons":{"items":{"$ref":"#/components/schemas/MoneyMovementBlockedReason"},"readOnly":true,"type":"array"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"default_payout_destinations":{"additionalProperties":{"type":"string"},"type":"object"},"delay_days":{"format":"int32","readOnly":true,"type":"integer"},"delay_days_override":{"format":"int32","type":"integer"},"interval":{"enum":["manual","daily","weekly","monthly"],"type":"string","x-enum-descriptions":["Manual.","Daily.","Weekly.","Monthly."],"x-flint-enum":"closed"},"merchant_id":{"readOnly":true,"type":"string"},"minimum_balance_by_currency":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"monthly_payout_days":{"items":{"format":"int32","type":"integer"},"type":"array"},"next_actions":{"items":{"$ref":"#/components/schemas/NextAction"},"readOnly":true,"type":"array"},"payout_settings_id":{"readOnly":true,"type":"string"},"statement_descriptor":{"type":"string"},"status":{"enum":["enabled","disabled","blocked","pending"],"readOnly":true,"type":"string","x-enum-descriptions":["Enabled.","Disabled.","Blocked.","Pending."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"weekly_payout_days":{"items":{"type":"string"},"type":"array"}},"required":["created_at","delay_days","interval","merchant_id","payout_settings_id","status","updated_at"],"type":"object"},"PayoutSettingsResponse":{"properties":{"data":{"$ref":"#/components/schemas/PayoutSettings"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PayoutTraceID":{"properties":{"status":{"enum":["pending","available","unsupported"],"type":"string","x-enum-descriptions":["Pending.","Available.","Unsupported."],"x-flint-enum":"open"},"value":{"type":"string"}},"required":["status"],"type":"object"},"PendingPaymentAction":{"description":"Client-side action required before continuing a payment. Resume an order through PayOrder with payment_attempt_id, or continue a standalone PaymentIntent through its confirm endpoint without a replacement credential.","properties":{"action_type":{"description":"Product-level action type. payment_authentication applies to a payment leg; payment_method_authentication applies to saving a future-billing payment method.","enum":["payment_authentication","payment_method_authentication"],"type":"string","x-enum-descriptions":["Payment authentication.","Payment method authentication."],"x-flint-enum":"closed"},"client_action":{"$ref":"#/components/schemas/PaymentClientAction","description":"Direct browser authority required to finish this action before continuing through Flint. Unlike collection guidance, this payload includes a client secret."},"pending_action_id":{"description":"Stable Flint action ID. Use this to deduplicate a repeated action projection while resuming an attempt.","type":"string"},"subject":{"$ref":"#/components/schemas/PendingPaymentActionSubject","description":"The attempt subject that requires browser action. Exactly one of payment_intent or setup_payment_source is present."}},"required":["action_type","client_action","pending_action_id","subject"],"type":"object"},"PendingPaymentActionPaymentIntentSubject":{"properties":{"payment_intent_id":{"type":"string"}},"required":["payment_intent_id"],"type":"object"},"PendingPaymentActionSetupPaymentSourceSubject":{"properties":{"payment_method_id":{"type":"string"}},"required":["payment_method_id"],"type":"object"},"PendingPaymentActionSubject":{"description":"Typed subject for a pending order payment action. Exactly one subject is present.","properties":{"payment_intent":{"$ref":"#/components/schemas/PendingPaymentActionPaymentIntentSubject","description":"PaymentIntent that requires buyer authentication. It can be a standalone intent or an order-owned payment leg."},"setup_payment_source":{"$ref":"#/components/schemas/PendingPaymentActionSetupPaymentSourceSubject","description":"Future-billing payment method setup that requires buyer authentication."}},"type":"object"},"PickupFulfillmentDetails":{"properties":{"address":{"$ref":"#/components/schemas/Address"},"curbside_instructions":{"description":"Instructions specific to curbside handoff.","maxLength":2048,"type":"string"},"customer_arrived_at":{"description":"Buyer-reported arrival time for curbside or counter pickup.","format":"date-time","type":"string"},"expires_at":{"description":"Deadline after which an uncollected pickup should enter merchant review.","format":"date-time","type":"string"},"instructions":{"type":"string"},"location_name":{"type":"string"},"picked_up_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"pickup_mode":{"enum":["in_store","curbside","locker","other"],"type":"string","x-enum-descriptions":["In store.","Curbside.","Locker.","Other."],"x-flint-enum":"closed"},"pickup_window_duration_seconds":{"description":"Width of the promised pickup window, from 0 to 86400 seconds.","format":"int64","maximum":86400,"minimum":0,"type":"integer"},"prep_time_duration_seconds":{"description":"Expected preparation time for restaurant and made-to-order pickup, from 0 to 86400 seconds.","format":"int64","maximum":86400,"minimum":0,"type":"integer"},"ready_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"vehicle_description":{"description":"Buyer vehicle description used for curbside handoff.","maxLength":500,"type":"string"},"window_end_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"window_start_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"type":"object"},"PolicyLocation":{"additionalProperties":false,"properties":{"group_priority":{"format":"int32","minimum":1,"type":"integer"},"location_id":{"type":"string"}},"required":["group_priority","location_id"],"type":"object"},"PostalAddress":{"properties":{"city":{"type":"string"},"country":{"description":"ISO 3166-1 alpha-2 country code.","example":"US","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"line1":{"type":"string"},"line2":{"type":"string"},"postal_code":{"type":"string"},"state":{"type":"string"}},"required":["city","country","line1","postal_code","state"],"type":"object"},"PrefilledCustomerInfo":{"properties":{"billing_address":{"$ref":"#/components/schemas/Address"},"email":{"type":"string"},"phone":{"type":"string"},"shipping_address":{"$ref":"#/components/schemas/Address"}},"type":"object"},"PricingAmounts":{"properties":{"charge_money":{"$ref":"#/components/schemas/Money"},"discount_money":{"$ref":"#/components/schemas/Money"},"requested_tip_money":{"$ref":"#/components/schemas/Money"},"subtotal_money":{"$ref":"#/components/schemas/Money"},"tax_money":{"$ref":"#/components/schemas/Money"},"total_money":{"$ref":"#/components/schemas/Money"}},"required":["charge_money","discount_money","requested_tip_money","subtotal_money","tax_money","total_money"],"type":"object"},"ProcessExistingReturnLineItemInput":{"additionalProperties":false,"properties":{"decision":{"$ref":"#/components/schemas/ReturnProcessDecision"},"disposition":{"$ref":"#/components/schemas/ReturnProcessDispositionInput"},"inspection":{"$ref":"#/components/schemas/ReturnProcessInspectionInput"},"received_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"resolution":{"$ref":"#/components/schemas/ReturnProcessResolutionInput"},"return_line_item_id":{"type":"string"}},"required":["return_line_item_id"],"type":"object"},"ProcessExistingReturnRequest":{"additionalProperties":false,"properties":{"completion_behavior":{"enum":["complete_when_ready","leave_open"],"type":"string","x-enum-descriptions":["Complete when ready.","Leave open."],"x-flint-enum":"closed"},"expected_version":{"format":"int64","minimum":1,"type":"integer"},"line_items":{"items":{"$ref":"#/components/schemas/ProcessExistingReturnLineItemInput"},"minItems":1,"type":"array"},"receipt":{"$ref":"#/components/schemas/ReturnProcessReceiptInput"}},"required":["line_items"],"type":"object"},"ProcessExistingReturnResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnProcessResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"Product":{"properties":{"active_variant_count":{"format":"int32","readOnly":true,"type":"integer"},"available_for_sale":{"readOnly":true,"type":"boolean"},"categories":{"items":{"$ref":"#/components/schemas/CategoryReference"},"type":"array"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"default_variant":{"$ref":"#/components/schemas/ProductVariant","readOnly":true},"default_variant_id":{"type":"string"},"delivery_configuration_status":{"enum":["configured","action_required","not_applicable"],"readOnly":true,"type":"string","x-enum-descriptions":["Configured.","Action required.","Not applicable."],"x-flint-enum":"open"},"description":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"images":{"items":{"$ref":"#/components/schemas/Image"},"type":"array"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"modifier_set":{"anyOf":[{"$ref":"#/components/schemas/ModifierSet"},{"type":"null"}],"readOnly":true},"modifier_set_id":{"description":"Attached modifier set. Send null on update to remove it.","pattern":"^ms_[0-9A-HJKMNP-TV-Z]{26}$","type":["string","null"]},"name":{"type":"string"},"option_count":{"format":"int32","readOnly":true,"type":"integer"},"options":{"items":{"$ref":"#/components/schemas/ProductOption"},"type":"array"},"price_range":{"$ref":"#/components/schemas/ProductPriceRange","readOnly":true},"product_id":{"readOnly":true,"type":"string"},"product_type":{"enum":["physical","service","fee","digital"],"type":"string","x-enum-descriptions":["Physical.","Service.","Fee.","Digital."],"x-flint-enum":"closed"},"status":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"variant_count":{"format":"int32","readOnly":true,"type":"integer"},"version":{"format":"uint64","minimum":0,"readOnly":true,"type":"integer"}},"required":["delivery_configuration_status","images","modifier_set_id","name","options","product_id","product_type","status","version"],"type":"object"},"ProductListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Product"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ProductOption":{"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"option_id":{"readOnly":true,"type":"string"},"position":{"format":"int32","type":"integer"},"product_id":{"readOnly":true,"type":"string"},"status":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"values":{"items":{"$ref":"#/components/schemas/ProductOptionValue"},"type":"array"}},"required":["name","option_id","position","product_id","status"],"type":"object"},"ProductOptionListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ProductOption"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ProductOptionResponse":{"properties":{"data":{"$ref":"#/components/schemas/ProductOption"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ProductOptionValue":{"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"option_value_id":{"readOnly":true,"type":"string"},"position":{"format":"int32","type":"integer"},"status":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"value":{"type":"string"}},"required":["option_value_id","position","value"],"type":"object"},"ProductPriceRange":{"properties":{"max_unit_price_money":{"$ref":"#/components/schemas/Money"},"min_unit_price_money":{"$ref":"#/components/schemas/Money"}},"required":["max_unit_price_money","min_unit_price_money"],"type":"object"},"ProductResponse":{"properties":{"data":{"$ref":"#/components/schemas/Product"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ProductVariant":{"properties":{"available_for_sale":{"readOnly":true,"type":"boolean"},"barcode":{"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"current_delivery_profile_revision_id":{"readOnly":true,"type":"string"},"delivery_configuration_reason":{"enum":["delivery_profile_missing","delivery_profile_inactive"],"readOnly":true,"type":"string","x-enum-descriptions":["Delivery profile missing.","Delivery profile inactive."],"x-flint-enum":"closed"},"delivery_configuration_status":{"enum":["configured","action_required","not_applicable"],"readOnly":true,"type":"string","x-enum-descriptions":["Configured.","Action required.","Not applicable."],"x-flint-enum":"open"},"delivery_profile_id":{"type":"string"},"effective_images":{"items":{"$ref":"#/components/schemas/Image"},"readOnly":true,"type":"array"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"images":{"items":{"$ref":"#/components/schemas/Image"},"type":"array"},"images_inherited":{"readOnly":true,"type":"boolean"},"inventory_item_id":{"description":"The inventory item this variant consumes. Present exactly when inventory_tracking is tracked. Several variants may share one inventory item.","type":"string"},"inventory_tracking":{"enum":["not_tracked","tracked"],"readOnly":true,"type":"string","x-enum-descriptions":["Not tracked.","Tracked."],"x-flint-enum":"closed"},"line_item_tax_category":{"description":"Flint line-item tax category.","enum":["general","physical_goods","digital_goods","software","saas","services","professional_services","food","prepared_food","clothing","medical_goods","admission"],"type":"string","x-enum-descriptions":["General.","Physical goods.","Digital goods.","Software.","Saas.","Services.","Professional services.","Food.","Prepared food.","Clothing.","Medical goods.","Admission."],"x-flint-enum":"closed"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"modifier_set":{"anyOf":[{"$ref":"#/components/schemas/ModifierSet"},{"type":"null"}],"readOnly":true},"modifier_set_id":{"description":"Attached modifier set. Send null on update to remove it.","pattern":"^ms_[0-9A-HJKMNP-TV-Z]{26}$","type":["string","null"]},"name":{"type":"string"},"position":{"format":"int32","type":"integer"},"product_id":{"readOnly":true,"type":"string"},"selected_options":{"items":{"$ref":"#/components/schemas/SelectedProductOption"},"readOnly":true,"type":"array"},"sku":{"type":"string"},"status":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"},"taxable":{"type":"boolean"},"unit_price_money":{"$ref":"#/components/schemas/Money"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"variant_id":{"readOnly":true,"type":"string"},"version":{"format":"uint64","minimum":0,"readOnly":true,"type":"integer"}},"required":["available_for_sale","delivery_configuration_status","effective_images","images","images_inherited","inventory_tracking","modifier_set_id","position","product_id","status","unit_price_money","variant_id","version"],"type":"object"},"ProductVariantInput":{"properties":{"barcode":{"type":"string"},"delivery_profile_id":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"images":{"description":"The complete desired gallery in display order. The first image is primary. Send [] to clear the gallery.","items":{"$ref":"#/components/schemas/ImageInput"},"maxItems":8,"minItems":0,"type":"array"},"inventory_item":{"$ref":"#/components/schemas/InventoryItemCreateInput"},"inventory_item_id":{"type":"string"},"line_item_tax_category":{"description":"Flint line-item tax category.","enum":["general","physical_goods","digital_goods","software","saas","services","professional_services","food","prepared_food","clothing","medical_goods","admission"],"type":"string","x-enum-descriptions":["General.","Physical goods.","Digital goods.","Software.","Saas.","Services.","Professional services.","Food.","Prepared food.","Clothing.","Medical goods.","Admission."],"x-flint-enum":"closed"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"modifier_set_id":{"description":"Attached modifier set. Send null on update to remove it.","pattern":"^ms_[0-9A-HJKMNP-TV-Z]{26}$","type":["string","null"]},"name":{"type":"string"},"position":{"format":"int32","type":"integer"},"selected_option_values":{"items":{"$ref":"#/components/schemas/ProductVariantSelectedOptionInput"},"type":"array"},"sku":{"type":"string"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"taxable":{"type":"boolean"},"unit_price_money":{"$ref":"#/components/schemas/Money"}},"required":["unit_price_money"],"type":"object"},"ProductVariantListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ProductVariant"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ProductVariantResponse":{"properties":{"data":{"$ref":"#/components/schemas/ProductVariant"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ProductVariantSelectedOptionInput":{"properties":{"client_option_key":{"type":"string"},"client_value_key":{"type":"string"},"option_value_id":{"type":"string"}},"type":"object"},"Promotion":{"properties":{"application_method":{"$ref":"#/components/schemas/PromotionApplicationMethod"},"codes_summary":{"$ref":"#/components/schemas/PromotionCodesSummary","description":"Read-only rollup of this promotion's codes. Present only on code-gated promotions; automatic promotions omit it."},"combines_with":{"$ref":"#/components/schemas/PromotionCombinesWith"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"description":{"type":"string"},"discount_class":{"enum":["order","line_item","service_charge"],"type":"string","x-enum-descriptions":["Order.","Line item.","Service charge."],"x-flint-enum":"closed"},"display_name":{"description":"Buyer-facing promotion name shown in checkout and order discount surfaces.","type":"string"},"eligibility_rules":{"$ref":"#/components/schemas/PromotionRuleGroup"},"exclusivity":{"$ref":"#/components/schemas/PromotionExclusivity"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"max_uses":{"format":"int64","type":"integer"},"merchant_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"description":"Internal promotion name for dashboards, searching, and reporting.","type":"string"},"promotion_id":{"type":"string"},"redemption_type":{"enum":["automatic","code"],"type":"string","x-enum-descriptions":["Automatic.","Code."],"x-flint-enum":"closed"},"schedule":{"$ref":"#/components/schemas/PromotionSchedule"},"stacking_mode":{"enum":["continue","stop_after"],"type":"string","x-enum-descriptions":["Continue.","Stop after."],"x-flint-enum":"closed"},"status":{"description":"Read-only, computed from the schedule, usage, and codes: active, inactive, expired, not_yet_started, exhausted, no_active_codes, or archived. Only active and inactive can be set via PATCH.","enum":["active","inactive","expired","not_yet_started","exhausted","no_active_codes","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Expired.","Not yet started.","Exhausted.","No active codes.","Archived."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"uses_count":{"format":"int64","type":"integer"}},"required":["application_method","discount_class","display_name","name","promotion_id","redemption_type","stacking_mode","status","uses_count"],"type":"object"},"PromotionApplicationMethod":{"additionalProperties":false,"description":"Canonical REST shape is flat: send type plus the effect fields on this object. Responses always use this flat shape.","oneOf":[{"properties":{"type":{"enum":["percent_off"],"type":"string","x-enum-descriptions":["Percent off."],"x-flint-enum":"closed"}},"required":["percent_off"]},{"properties":{"type":{"enum":["amount_off"],"type":"string","x-enum-descriptions":["Amount off."],"x-flint-enum":"closed"}},"required":["amount_off_money"]},{"properties":{"type":{"enum":["buy_x_get_y"],"type":"string","x-enum-descriptions":["Buy x get y."],"x-flint-enum":"closed"}},"required":["qualifying_item_rules","buy_min_quantity","discounted_item_rules","get_quantity","get_percent_off"]}],"properties":{"allocation":{"description":"How the effect is applied across the matched items or charges. each applies the effect to every matched item independently: a fixed amount_off is charged per item (10 USD off 3 items discounts 30 USD, each capped at the item price), and a percent_off is taken from each item. across applies the effect once to the matched set as a whole: a fixed amount_off is the whole amount one time (10 USD off the group total, not prorated per item), and a percent_off is taken from the combined subtotal. For percent_off the two produce the same total and differ only in how the discount is attributed to individual line items; for amount_off they differ by the number of matched items, so set it deliberately. Defaults to each for line_item and service_charge promotions and across for order promotions. max_discounted_quantity requires each.","enum":["each","across"],"type":"string","x-enum-descriptions":["Each.","Across."],"x-flint-enum":"closed"},"amount_off_money":{"$ref":"#/components/schemas/Money"},"applies_to":{"description":"Reserved for future subscription promotion support. Do not send this field in requests.","enum":["order","line_item","subscription","subscription_item"],"readOnly":true,"type":"string","x-enum-descriptions":["Order.","Line item.","Subscription.","Subscription item."],"x-flint-enum":"closed"},"buy_min_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","minimum":1,"type":"integer"},"calculation_basis":{"description":"Basis for merchandise promotion calculations. Omit for service_charge promotions because service-charge discounts are calculated from the targeted charges.","enum":["subtotal_pre_tax","subtotal_post_tax"],"type":"string","x-enum-descriptions":["Subtotal pre tax.","Subtotal post tax."],"x-flint-enum":"closed"},"currency_options":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"discounted_item_rules":{"$ref":"#/components/schemas/PromotionRuleGroup","description":"Which line items receive the discount. Required for service_charge promotions, and for line_item promotions whose eligibility_rules include any non-line-item condition (for example order.subtotal or a customer condition). It is optional only when eligibility_rules consist entirely of line_item.* conditions (plus matched_items.subtotal), in which case the matched items are used as the target. Omitting it otherwise returns DISCOUNTED_ITEM_RULES_REQUIRED."},"get_percent_off":{"maximum":100,"minimum":1,"multipleOf":0.0001,"type":"number"},"get_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","minimum":1,"type":"integer"},"max_applications_per_order":{"format":"int32","minimum":1,"type":"integer"},"max_discounted_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","minimum":1,"type":"integer"},"percent_off":{"maximum":100,"minimum":1,"multipleOf":0.0001,"type":"number"},"qualifying_item_rules":{"$ref":"#/components/schemas/PromotionRuleGroup"},"recurrence":{"$ref":"#/components/schemas/PromotionRecurrence","description":"Optional on order promotion writes, but only recurrence.type = once is accepted. Subscription recurrence values are reserved for future subscription promotion support."},"reward_selection":{"enum":["cheapest","highest_price","first_added"],"type":"string","x-enum-descriptions":["Cheapest.","Highest price.","First added."],"x-flint-enum":"closed"},"type":{"enum":["percent_off","amount_off","buy_x_get_y"],"type":"string","x-enum-descriptions":["Percent off.","Amount off.","Buy x get y."],"x-flint-enum":"closed"}},"type":"object"},"PromotionCandidate":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money","description":"Calculated discount amount for this promotion candidate before final application, when available."},"applied_money":{"$ref":"#/components/schemas/Money","description":"Discount amount applied to the order for candidates in applied[]."},"combines_with":{"$ref":"#/components/schemas/PromotionCombinesWith"},"current_money":{"$ref":"#/components/schemas/Money","description":"Current money amount counted toward threshold_money for available[] candidates."},"customer_facing_name":{"type":"string"},"discount_class":{"enum":["order","line_item","service_charge"],"type":"string","x-enum-descriptions":["Order.","Line item.","Service charge."],"x-flint-enum":"closed"},"exclusivity":{"$ref":"#/components/schemas/PromotionExclusivity"},"gap_money":{"$ref":"#/components/schemas/Money","description":"Additional money amount needed to reach threshold_money for available[] candidates."},"order_charge_ids":{"items":{"type":"string"},"type":"array"},"order_line_item_ids":{"items":{"type":"string"},"type":"array"},"promotion_code":{"type":"string"},"promotion_code_id":{"type":"string"},"promotion_decline_reason":{"enum":["not_eligible","minimum_not_met","expired","not_yet_started","exhausted","code_required","code_invalid","disabled","automatic_disabled","codes_disabled","already_applied","not_combinable","superseded_by_better_offer","superseded","max_promotions_reached","no_discountable_balance","buy_item_missing","currency_mismatch","unknown_type"],"type":"string","x-enum-descriptions":["Not eligible.","Minimum not met.","Expired.","Not yet started.","Exhausted.","Code required.","Code invalid.","Disabled.","Automatic disabled.","Codes disabled.","Already applied.","Not combinable.","Superseded by better offer.","Superseded.","Max promotions reached.","No discountable balance.","Buy item missing.","Currency mismatch.","Unknown type."],"x-flint-enum":"closed"},"promotion_id":{"type":"string"},"stacking_mode":{"enum":["continue","stop_after"],"type":"string","x-enum-descriptions":["Continue.","Stop after."],"x-flint-enum":"closed"},"threshold_money":{"$ref":"#/components/schemas/Money","description":"Minimum money amount required by a threshold rule for available[] candidates."},"would_have_applied_money":{"$ref":"#/components/schemas/Money","description":"Discount amount this candidate would have applied if it had been eligible and won conflict resolution."}},"required":["customer_facing_name","promotion_id"],"type":"object"},"PromotionCode":{"properties":{"code":{"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"max_uses":{"format":"int64","type":"integer"},"merchant_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"promotion_code_id":{"type":"string"},"promotion_id":{"type":"string"},"status":{"description":"Read-only, computed from stored active or inactive state, expires_at, and max_uses: active, inactive, expired, or exhausted. Only active and inactive can be set via PATCH.","enum":["active","inactive","expired","exhausted"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Expired.","Exhausted."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"uses_count":{"format":"int64","type":"integer"}},"required":["code","promotion_code_id","promotion_id","status","uses_count"],"type":"object"},"PromotionCodeListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PromotionCode"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PromotionCodeResolution":{"properties":{"promotion":{"$ref":"#/components/schemas/Promotion"},"promotion_code":{"$ref":"#/components/schemas/PromotionCode"}},"required":["promotion","promotion_code"],"type":"object"},"PromotionCodeResolutionResponse":{"properties":{"data":{"$ref":"#/components/schemas/PromotionCodeResolution"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PromotionCodeResponse":{"properties":{"data":{"$ref":"#/components/schemas/PromotionCode"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PromotionCodesSummary":{"properties":{"active_count":{"description":"Number of codes that can still be redeemed right now. Zero means the promotion reads as no_active_codes.","format":"int32","type":"integer"},"newest_active_code":{"description":"Most recently created redeemable code. Omitted when active_count is zero.","type":"string"},"total_count":{"description":"Number of codes on the promotion, excluding deleted codes.","format":"int32","type":"integer"}},"required":["active_count","total_count"],"type":"object"},"PromotionCombinesWith":{"properties":{"line_item":{"type":"boolean"},"order":{"type":"boolean"},"service_charge":{"type":"boolean"}},"type":"object"},"PromotionExclusivity":{"properties":{"group":{"type":"string"},"priority":{"format":"int32","type":"integer"},"selection":{"enum":["best_of","highest_priority"],"type":"string","x-enum-descriptions":["Best of.","Highest priority."],"x-flint-enum":"closed"}},"required":["group","selection"],"type":"object"},"PromotionListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Promotion"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PromotionRecurrence":{"properties":{"period_count":{"format":"int32","type":"integer"},"type":{"description":"Only once is accepted on order promotion writes. Subscription recurrence values are reserved for future subscription promotion support.","enum":["once"],"type":"string","x-enum-descriptions":["Once."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},"PromotionRefInput":{"additionalProperties":false,"oneOf":[{"not":{"anyOf":[{"required":["promotion_code"]}]},"required":["promotion_id"]},{"not":{"anyOf":[{"required":["promotion_id"]}]},"required":["promotion_code"]}],"properties":{"promotion_code":{"description":"Human-entered promotion code. Use this when redeeming a campaign code.","type":"string"},"promotion_id":{"description":"Flint promotion ID. Use this for server-side apply flows where you already know the promotion.","type":"string"}},"type":"object"},"PromotionResponse":{"properties":{"data":{"$ref":"#/components/schemas/Promotion"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PromotionRule":{"additionalProperties":false,"properties":{"attribute":{"description":"Field the rule tests. The attribute fixes the value type and the operators that are legal for it: money attributes accept comparison operators but not eq or in, booleans accept eq only, and so on. The full attribute/type/operator matrix is machine-readable in x-flint-rule-attributes on this schema. metadata.\u003ckey\u003e reads a string from the customer's metadata and accepts the string operators. A disallowed operator is rejected at create time with INVALID_OPERATOR, whose message names the operators allowed for the attribute.","type":"string","x-flint-rule-attributes":[{"attribute":"charge.type","operators":["eq","ne","in","contains","is_defined"],"type":"string"},{"attribute":"choice_group.merchandise_subtotal_after_line_item_discounts","operators":["gt","gte","lt","lte"],"type":"money"},{"attribute":"choice_group.merchandise_subtotal_before_discounts","operators":["gt","gte","lt","lte"],"type":"money"},{"attribute":"customer.group_id","operators":["eq","in","is_defined"],"type":"string"},{"attribute":"customer.is_verified","operators":["eq"],"type":"bool"},{"attribute":"delivery_choice.method_id","operators":["eq","ne","in","contains","is_defined"],"type":"string"},{"attribute":"delivery_choice.raw_amount","operators":["gt","gte","lt","lte"],"type":"money"},{"attribute":"delivery_choice.type","operators":["eq","ne","in","contains","is_defined"],"type":"string"},{"attribute":"delivery_choice_group.id","operators":["eq","ne","in","contains","is_defined"],"type":"string"},{"attribute":"line_item.bundle_id","operators":["eq","ne","in","contains","is_defined"],"type":"string"},{"attribute":"line_item.categories","operators":["eq","ne","in","is_defined"],"type":"string"},{"attribute":"line_item.product_id","operators":["eq","ne","in","contains","is_defined"],"type":"string"},{"attribute":"line_item.quantity","operators":["eq","ne","gt","gte","lt","lte","in","is_defined"],"type":"number"},{"attribute":"line_item.variant_id","operators":["eq","ne","in","contains","is_defined"],"type":"string"},{"attribute":"matched_items.subtotal","operators":["gt","gte","lt","lte"],"type":"money"},{"attribute":"order.currency","operators":["eq","ne","in","contains","is_defined"],"type":"string"},{"attribute":"order.merchandise_subtotal_after_line_item_discounts","operators":["gt","gte","lt","lte"],"type":"money"},{"attribute":"order.merchandise_subtotal_before_discounts","operators":["gt","gte","lt","lte"],"type":"money"},{"attribute":"order.subtotal","operators":["gt","gte","lt","lte"],"type":"money"}]},"currency_options":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"},"operator":{"enum":["eq","ne","gt","gte","lt","lte","in","contains","is_defined"],"type":"string","x-enum-descriptions":["Eq.","Ne.","Gt.","Gte.","Lt.","Lte.","In.","Contains.","Is defined."],"x-flint-enum":"closed"},"values":{"items":{"$ref":"#/components/schemas/PromotionRuleValue"},"type":"array"}},"required":["attribute","operator"],"type":"object"},"PromotionRuleGroup":{"description":"A rule group is exactly one of three forms, never a blend: an array of rules for a simple list (an implicit AND), an object with only all for nested AND, or an object with only any for OR. The all and any arrays contain rules or nested rule groups. There is no rules key. Sending a rules key, an unexpected key, or both all and any is rejected with INVALID_RULE_GROUP.","oneOf":[{"items":{"$ref":"#/components/schemas/PromotionRule"},"type":"array"},{"additionalProperties":false,"properties":{"all":{"items":{"oneOf":[{"$ref":"#/components/schemas/PromotionRule"},{"$ref":"#/components/schemas/PromotionRuleGroup"}]},"type":"array"}},"required":["all"],"type":"object"},{"additionalProperties":false,"properties":{"any":{"items":{"oneOf":[{"$ref":"#/components/schemas/PromotionRule"},{"$ref":"#/components/schemas/PromotionRuleGroup"}]},"type":"array"}},"required":["any"],"type":"object"}]},"PromotionRuleValue":{"description":"Rule comparison value. Use a primitive string, number, boolean, or a money object.","oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"$ref":"#/components/schemas/Money"}]},"PromotionSchedule":{"properties":{"ends_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"starts_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"type":"object"},"PromotionSettings":{"properties":{"automatic_enabled":{"type":"boolean"},"codes_enabled":{"description":"Merchant promotion code redemption policy. Explicit false rejects promotion-code application even when a checkout or payment link asks to show code entry.","type":"boolean"},"max_promotions_per_order":{"format":"int32","type":"integer"}},"type":"object"},"PublicDownload":{"properties":{"expires_at":{"description":"Download expiration instant.","format":"date-time","readOnly":true,"type":"string"},"report_download_id":{"pattern":"^rdl_[0-9A-HJKMNP-TV-Z]{26}$","readOnly":true,"type":"string"},"url":{"readOnly":true,"type":"string"}},"required":["expires_at","report_download_id","url"],"type":"object"},"PublicFraudWarningPaymentSummary":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"email":{"type":"string"},"last4":{"type":"string"},"payment_method_brand":{"enum":["amex","discover","diners","jcb","mastercard","unionpay","visa","unknown"],"type":"string","x-enum-descriptions":["Amex.","Discover.","Diners.","Jcb.","Mastercard.","Unionpay.","Visa.","Unknown."],"x-flint-enum":"closed"}},"required":["amount_money","email","last4","payment_method_brand"],"type":"object"},"PublicIPAddressLocation":{"properties":{"city":{"type":"string"},"country":{"description":"ISO 3166-1 alpha-2 country code.","example":"US","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"region":{"type":"string"}},"required":["city","country","latitude","longitude","region"],"type":"object"},"PublicPaymentLink":{"properties":{"completed_count":{"format":"int32","type":"integer"},"custom_fields":{"items":{"$ref":"#/components/schemas/PaymentLinkCustomField"},"type":"array"},"custom_text":{"$ref":"#/components/schemas/CheckoutCustomTextConfig"},"description":{"type":"string"},"donation_max_amount_money":{"$ref":"#/components/schemas/Money"},"donation_min_amount_money":{"$ref":"#/components/schemas/Money"},"donation_suggested_amount_money_options":{"items":{"$ref":"#/components/schemas/Money"},"type":"array"},"event_config":{"$ref":"#/components/schemas/PaymentLinkEventConfig"},"image":{"$ref":"#/components/schemas/Image"},"inactive_message":{"type":"string"},"legal":{"$ref":"#/components/schemas/CheckoutLegalConfig"},"line_items":{"items":{"$ref":"#/components/schemas/PaymentLinkLineItem"},"type":"array"},"max_completions":{"format":"int32","type":"integer"},"name":{"type":"string"},"payment_link_id":{"type":"string"},"payment_link_type":{"enum":["standard","donation","event"],"type":"string","x-enum-descriptions":["Standard.","Donation.","Event."],"x-flint-enum":"closed"},"payments":{"$ref":"#/components/schemas/CheckoutPaymentConfig"},"plan_id":{"type":"string"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"theme":{"$ref":"#/components/schemas/ThemeConfig"},"version":{"format":"int64","type":"integer"}},"required":["completed_count","name","payment_link_id","status","version"],"type":"object"},"PublicPaymentLinkResponse":{"properties":{"data":{"$ref":"#/components/schemas/PublicPaymentLinkResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"PublicPaymentLinkResult":{"properties":{"is_sold_out":{"type":"boolean"},"merchant_logo":{"$ref":"#/components/schemas/Image"},"merchant_name":{"type":"string"},"payment_link":{"$ref":"#/components/schemas/PublicPaymentLink"},"remaining_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","type":"integer"},"resolution_context":{"type":"string"},"resolution_context_expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"resolution_context_start_deadline_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"resolved_line_items":{"items":{"$ref":"#/components/schemas/PublicResolvedLineItemInfo"},"type":"array"},"subscription_preview":{"$ref":"#/components/schemas/PaymentLinkSubscriptionPreview","description":"Present for active plan-backed payment links when authoritative subscription terms are available."}},"required":["payment_link","resolution_context","resolution_context_expires_at","resolution_context_start_deadline_at"],"type":"object"},"PublicResolvedBundleComponent":{"properties":{"position":{"format":"int32","type":"integer"},"product_id":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","type":"integer"},"variant":{"$ref":"#/components/schemas/PublicResolvedBundleVariantSummary"},"variant_id":{"type":"string"}},"required":["position","quantity","variant_id"],"type":"object"},"PublicResolvedBundleVariantSummary":{"properties":{"available_for_sale":{"type":"boolean"},"name":{"type":"string"},"selected_options":{"items":{"$ref":"#/components/schemas/SelectedProductOption"},"type":"array"},"sku":{"type":"string"},"variant_id":{"type":"string"}},"required":["available_for_sale","variant_id"],"type":"object"},"PublicResolvedLineItemInfo":{"properties":{"available_modifiers":{"items":{"$ref":"#/components/schemas/PublicResolvedModifierGroup"},"type":"array"},"bundle_components":{"items":{"$ref":"#/components/schemas/PublicResolvedBundleComponent"},"type":"array"},"bundle_id":{"type":"string"},"catalog_object_type":{"enum":["unknown","variant","bundle"],"type":"string","x-enum-descriptions":["Unknown.","Variant.","Bundle."],"x-flint-enum":"closed"},"image":{"$ref":"#/components/schemas/Image"},"is_inventory_tracked":{"type":"boolean"},"key":{"type":"string"},"product_id":{"type":"string"},"resolved_description":{"type":"string"},"resolved_name":{"type":"string"},"resolved_unit_price_money":{"$ref":"#/components/schemas/Money"},"selected_options":{"items":{"$ref":"#/components/schemas/SelectedProductOption"},"type":"array"},"variant_id":{"type":"string"}},"required":["key"],"type":"object"},"PublicResolvedModifierGroup":{"properties":{"allow_quantities":{"type":"boolean"},"max_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"max_selected":{"format":"int32","type":"integer"},"max_total_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"min_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"min_selected":{"format":"int32","type":"integer"},"modifier_group_id":{"type":"string"},"modifier_group_type":{"enum":["unknown","list","text"],"type":"string","x-enum-descriptions":["Unknown.","List.","Text."],"x-flint-enum":"closed"},"name":{"type":"string"},"options":{"items":{"$ref":"#/components/schemas/PublicResolvedModifierOption"},"type":"array"},"position":{"format":"int32","type":"integer"},"pricing_scope":{"enum":["unknown","per_item","per_line"],"type":"string","x-enum-descriptions":["Unknown.","Per item.","Per line."],"x-flint-enum":"closed"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"text":{"$ref":"#/components/schemas/PublicResolvedTextModifier"}},"required":["modifier_group_id","modifier_group_type","name"],"type":"object"},"PublicResolvedModifierOption":{"properties":{"available":{"type":"boolean"},"default_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"hidden":{"type":"boolean"},"line_item_tax_category":{"description":"Flint line-item tax category.","enum":["general","physical_goods","digital_goods","software","saas","services","professional_services","food","prepared_food","clothing","medical_goods","admission"],"type":"string","x-enum-descriptions":["General.","Physical goods.","Digital goods.","Software.","Saas.","Services.","Professional services.","Food.","Prepared food.","Clothing.","Medical goods.","Admission."],"x-flint-enum":"closed"},"modifier_id":{"type":"string"},"name":{"type":"string"},"position":{"format":"int32","type":"integer"},"selected_by_default":{"type":"boolean"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"taxable":{"type":"boolean"},"unit_price_delta_money":{"$ref":"#/components/schemas/Money"}},"required":["available","modifier_id","name","unit_price_delta_money"],"type":"object"},"PublicResolvedTextModifier":{"properties":{"max_length":{"format":"int32","type":"integer"},"min_length":{"format":"int32","type":"integer"},"multiline":{"type":"boolean"},"required":{"type":"boolean"}},"type":"object"},"PublicReviewRisk":{"properties":{"level":{"enum":["normal","elevated","highest","not_assessed"],"type":"string","x-enum-descriptions":["Normal.","Elevated.","Highest.","Not assessed."],"x-flint-enum":"closed"},"score":{"format":"int32","type":["integer","null"]}},"required":["level","score"],"type":"object"},"PublicRiskAttribute":{"properties":{"available":{"type":"boolean"},"available_from":{"enum":["pre_authorization","post_authorization"],"type":"string","x-enum-descriptions":["Pre authorization.","Post authorization."],"x-flint-enum":"closed"},"enum_values":{"items":{"type":"string"},"type":"array"},"missing_value_behavior":{"enum":["not_applicable_except_is_missing"],"type":"string","x-enum-descriptions":["Not applicable except is missing."],"x-flint-enum":"closed"},"name":{"type":"string"},"nullable":{"type":"boolean"},"operators":{"items":{"type":"string"},"type":"array"},"unavailable_reason":{"enum":["risk_scoring_not_enabled","ip_geolocation_not_enabled"],"type":"string","x-enum-descriptions":["Risk scoring not enabled.","Ip geolocation not enabled."],"x-flint-enum":"closed"},"value_type":{"enum":["money","currency","string","enum","country","email","ip_address","boolean","integer"],"type":"string","x-enum-descriptions":["Money.","Currency.","String.","Enum.","Country.","Email.","Ip address.","Boolean.","Integer."],"x-flint-enum":"closed"}},"required":["available","available_from","missing_value_behavior","name","nullable","operators","value_type"],"type":"object"},"PublicRiskAttributeRegistry":{"properties":{"attributes":{"items":{"$ref":"#/components/schemas/PublicRiskAttribute"},"type":"array"},"version":{"type":"string"}},"required":["attributes","version"],"type":"object"},"PublicRiskListItemResult":{"properties":{"risk_list_item":{"$ref":"#/components/schemas/RiskListItem"},"status":{"enum":["created","existing"],"type":"string","x-enum-descriptions":["Created.","Existing."],"x-flint-enum":"open"}},"required":["risk_list_item","status"],"type":"object"},"PublicRiskPaymentSummary":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"authorization_expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]},"capture_method":{"enum":["automatic","manual"],"type":"string","x-enum-descriptions":["Automatic.","Manual."],"x-flint-enum":"closed"},"email":{"type":"string"},"last4":{"type":"string"},"payment_method_brand":{"enum":["amex","discover","diners","jcb","mastercard","unionpay","visa","unknown"],"type":"string","x-enum-descriptions":["Amex.","Discover.","Diners.","Jcb.","Mastercard.","Unionpay.","Visa.","Unknown."],"x-flint-enum":"closed"}},"required":["amount_money","capture_method","authorization_expires_at","payment_method_brand","last4","email"],"type":"object"},"PublishLocationGeographyRequest":{"properties":{"address":{"$ref":"#/components/schemas/LocationAddress"},"coordinate":{"$ref":"#/components/schemas/LocationCoordinate"},"coordinate_source":{"enum":["merchant_supplied","geocoded",null],"type":["string","null"],"x-enum-descriptions":["Merchant supplied.","Geocoded.","Null."],"x-flint-enum":"closed"},"expected_geography_revision":{"format":"uint64","minimum":0,"type":"integer"},"timezone":{"type":"string"}},"required":["address","expected_geography_revision","timezone"],"type":"object"},"PublishReturnPolicyRevisionRequest":{"additionalProperties":false,"properties":{"expected_current_return_policy_revision_id":{"type":"string"},"expected_version":{"format":"int64","minimum":1,"type":"integer"},"revision":{"$ref":"#/components/schemas/ReturnPolicyRevisionInput"}},"required":["expected_current_return_policy_revision_id","revision"],"type":"object"},"PublishReturnPolicyRevisionResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnPolicy"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"QueryDeliveryPickupAvailabilityRequest":{"properties":{"buyer_location":{"$ref":"#/components/schemas/DeliveryBuyerLocationInput"},"expected_delivery_selection_id":{"type":"string"},"maximum_distance":{"$ref":"#/components/schemas/DeliveryPickupAvailabilityMaximumDistanceRequest"}},"type":"object"},"QuotaDetails":{"properties":{"limit_bytes":{"description":"Maximum bytes available for the resource in the authenticated scope.","format":"int64","type":"integer"},"next_expiration_at":{"description":"RFC 3339 time when the next ready unattached image becomes eligible for cleanup, when known.","format":"date-time","type":"string"},"ready_unattached_bytes":{"description":"Stored bytes held by completed images that are not attached to a resource.","format":"int64","type":"integer"},"reserved_bytes":{"description":"Bytes reserved by in-progress resource mutations.","format":"int64","type":"integer"},"resource":{"description":"Stable resource name whose quota was exhausted.","type":"string"},"used_bytes":{"description":"Bytes currently stored for the resource in the authenticated scope.","format":"int64","type":"integer"}},"required":["limit_bytes","ready_unattached_bytes","reserved_bytes","resource","used_bytes"],"type":"object"},"ReceiptSettings":{"properties":{"footer_text":{"type":"string"},"header_text":{"type":"string"},"is_auto_email_enabled":{"type":"boolean"},"is_itemized":{"type":"boolean"}},"type":"object"},"RefreshCustomerSessionRequest":{"properties":{"refresh_token":{"type":"string"}},"required":["refresh_token"],"type":"object"},"Refund":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"credit_note_id":{"readOnly":true,"type":"string"},"customer":{"anyOf":[{"$ref":"#/components/schemas/ExpandedCustomerSummary"},{"type":"null"}],"readOnly":true},"customer_id":{"readOnly":true,"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"failure_reason":{"description":"Flint-normalized refund failure reason. Unknown provider values are returned as refund_failed.","enum":["expired_or_canceled_card","lost_or_stolen_card","insufficient_funds","insufficient_available_balance","declined","merchant_request","payment_disputed","payment_refund_failed","refund_failed"],"readOnly":true,"type":"string","x-enum-descriptions":["Expired or canceled card.","Lost or stolen card.","Insufficient funds.","Insufficient available balance.","Declined.","Merchant request.","Payment disputed.","Payment refund failed.","Refund failed."],"x-flint-enum":"closed"},"idempotency_key":{"readOnly":true,"type":"string"},"invoice_id":{"readOnly":true,"type":"string"},"line_item_allocations":{"items":{"$ref":"#/components/schemas/RefundLineItemAllocation"},"readOnly":true,"type":"array"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrderSummary"},{"type":"null"}],"readOnly":true},"order_id":{"type":"string"},"payment_intent":{"anyOf":[{"$ref":"#/components/schemas/ExpandedPaymentIntentSummary"},{"type":"null"}],"readOnly":true},"payment_intent_id":{"type":"string"},"payment_refunds":{"items":{"$ref":"#/components/schemas/PaymentRefund"},"readOnly":true,"type":"array"},"reason":{"enum":["duplicate","fraudulent","requested_by_customer","defective_product","wrong_item_shipped","never_received","not_as_described","arrived_too_late","customer_changed_mind","better_price_found","accidental_order","other",null],"type":["string","null"],"x-enum-descriptions":["Duplicate.","Fraudulent.","Requested by customer.","Defective product.","Wrong item shipped.","Never received.","Not as described.","Arrived too late.","Customer changed mind.","Better price found.","Accidental order.","Other.","Null."],"x-flint-enum":"closed"},"reason_message":{"type":"string"},"refund_id":{"readOnly":true,"type":"string"},"refund_method":{"enum":["original_payment"],"type":"string","x-enum-descriptions":["Original payment."],"x-flint-enum":"closed"},"refunded_tip_money":{"$ref":"#/components/schemas/Money","readOnly":true},"return_id":{"readOnly":true,"type":"string"},"return_resolution_id":{"readOnly":true,"type":"string"},"review_id":{"readOnly":true,"type":"string"},"status":{"enum":["pending","in_transit","succeeded","failed","requires_action","canceled","partially_succeeded"],"readOnly":true,"type":"string","x-enum-descriptions":["Pending.","In transit.","Succeeded.","Failed.","Requires action.","Canceled.","Partially succeeded."],"x-flint-enum":"open"},"tax_breakdown_refunds":{"items":{"$ref":"#/components/schemas/RefundTaxBreakdownRefund"},"type":"array"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"}},"required":["amount_money","refund_id","refunded_tip_money","status"],"type":"object"},"RefundAdjustmentAudit":{"properties":{"actor_id":{"type":"string"},"actor_type":{"enum":["user","system","admin"],"type":"string","x-enum-descriptions":["User.","System.","Admin."],"x-flint-enum":"closed"},"source":{"type":"string"}},"required":["actor_id","actor_type","source"],"type":"object"},"RefundAdjustmentReason":{"properties":{"code":{"type":"string"},"description":{"type":"string"}},"required":["code"],"type":"object"},"RefundCharge":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"order_charge_id":{"type":"string"}},"required":["order_charge_id"],"type":"object"},"RefundLineItem":{"properties":{"adjustment_refunds":{"items":{"$ref":"#/components/schemas/RefundLineItemAdjustmentRefundIn"},"type":"array"},"amount_money":{"$ref":"#/components/schemas/Money"},"order_line_item_id":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"refund_adjustments":{"items":{"$ref":"#/components/schemas/RefundLineItemAdjustmentIn"},"type":"array"},"tax_adjustment_audit":{"$ref":"#/components/schemas/RefundAdjustmentAudit"},"tax_adjustment_reason":{"$ref":"#/components/schemas/RefundAdjustmentReason"},"tax_breakdown_refunds":{"items":{"$ref":"#/components/schemas/RefundTaxBreakdownRefundIn"},"type":"array"},"tax_money":{"$ref":"#/components/schemas/Money"},"tax_refund_mode":{"enum":["automatic","explicit"],"type":"string","x-enum-descriptions":["Automatic.","Explicit."],"x-flint-enum":"closed"}},"required":["order_line_item_id"],"type":"object"},"RefundLineItemAdjustment":{"properties":{"adjustment_type":{"enum":["restocking_fee","withheld_amount","refund_adjustment","tax_adjustment"],"type":"string","x-enum-descriptions":["Restocking fee.","Withheld amount.","Refund adjustment.","Tax adjustment."],"x-flint-enum":"closed"},"amount_money":{"$ref":"#/components/schemas/Money"},"applies_to":{"type":"string"},"reason":{"$ref":"#/components/schemas/RefundAdjustmentReason"},"refund_line_item_adjustment_id":{"readOnly":true,"type":"string"},"refunded_money":{"$ref":"#/components/schemas/Money","readOnly":true},"remaining_money":{"$ref":"#/components/schemas/Money","readOnly":true}},"required":["adjustment_type","amount_money","applies_to","reason","refund_line_item_adjustment_id","refunded_money","remaining_money"],"type":"object"},"RefundLineItemAdjustmentIn":{"properties":{"adjustment_type":{"enum":["restocking_fee","withheld_amount","refund_adjustment","tax_adjustment"],"type":"string","x-enum-descriptions":["Restocking fee.","Withheld amount.","Refund adjustment.","Tax adjustment."],"x-flint-enum":"closed"},"amount_money":{"$ref":"#/components/schemas/Money"},"applies_to":{"type":"string"},"reason":{"$ref":"#/components/schemas/RefundAdjustmentReason"}},"required":["adjustment_type","applies_to"],"type":"object"},"RefundLineItemAdjustmentRefund":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money","readOnly":true},"original_refund_line_item_adjustment_id":{"readOnly":true,"type":"string"},"refund_line_item_adjustment_refund_id":{"readOnly":true,"type":"string"}},"required":["amount_money","original_refund_line_item_adjustment_id","refund_line_item_adjustment_refund_id"],"type":"object"},"RefundLineItemAdjustmentRefundIn":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"refund_line_item_adjustment_id":{"type":"string"}},"required":["refund_line_item_adjustment_id"],"type":"object"},"RefundLineItemAllocation":{"properties":{"adjustment_refunds":{"items":{"$ref":"#/components/schemas/RefundLineItemAdjustmentRefund"},"readOnly":true,"type":"array"},"adjustments":{"items":{"$ref":"#/components/schemas/RefundLineItemAdjustment"},"readOnly":true,"type":"array"},"automatic_refund":{"$ref":"#/components/schemas/RefundLineItemAutomaticRefund","readOnly":true},"bundle_id":{"readOnly":true,"type":"string"},"categories":{"items":{"$ref":"#/components/schemas/CategoryReference"},"readOnly":true,"type":"array"},"modifiers":{"items":{"$ref":"#/components/schemas/RefundLineItemModifierAllocation"},"readOnly":true,"type":"array"},"order_line_item_id":{"type":"string"},"product_id":{"readOnly":true,"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"refunded_money":{"$ref":"#/components/schemas/Money","readOnly":true},"selected_options":{"items":{"$ref":"#/components/schemas/SelectedProductOption"},"readOnly":true,"type":"array"},"sku":{"readOnly":true,"type":"string"},"source_type":{"enum":["variant","bundle"],"readOnly":true,"type":"string","x-enum-descriptions":["Variant.","Bundle."],"x-flint-enum":"closed"},"tax_breakdown_refunds":{"items":{"$ref":"#/components/schemas/RefundTaxBreakdownRefund"},"type":"array"},"tax_refund_mode":{"enum":["automatic","explicit"],"type":"string","x-enum-descriptions":["Automatic.","Explicit."],"x-flint-enum":"closed"},"variant_id":{"readOnly":true,"type":"string"}},"required":["automatic_refund","order_line_item_id","quantity","refunded_money","tax_refund_mode"],"type":"object"},"RefundLineItemAutomaticRefund":{"properties":{"discount_money":{"$ref":"#/components/schemas/Money","readOnly":true},"subtotal_money":{"$ref":"#/components/schemas/Money","readOnly":true},"tax_money":{"$ref":"#/components/schemas/Money","readOnly":true},"total_money":{"$ref":"#/components/schemas/Money","readOnly":true}},"required":["discount_money","subtotal_money","tax_money","total_money"],"type":"object"},"RefundLineItemModifierAllocation":{"properties":{"allocation_basis":{"type":"string"},"amount_money":{"$ref":"#/components/schemas/Money"},"modifier_group_name":{"type":"string"},"name":{"type":"string"},"order_line_item_modifier_id":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"refund_line_item_modifier_allocation_id":{"type":"string"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"source_type":{"type":"string"},"text_value":{"type":"string"}},"required":["allocation_basis","amount_money","modifier_group_name","name","quantity","refund_line_item_modifier_allocation_id","show_on_fulfillment","show_on_receipt","source_type"],"type":"object"},"RefundListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Refund"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"RefundResponse":{"properties":{"data":{"$ref":"#/components/schemas/Refund"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"RefundTaxBreakdownRefund":{"properties":{"order_charge_id":{"readOnly":true,"type":"string"},"tax_breakdown_id":{"readOnly":true,"type":"string"},"tax_money":{"$ref":"#/components/schemas/Money","readOnly":true}},"required":["tax_breakdown_id","tax_money"],"type":"object"},"RefundTaxBreakdownRefundIn":{"properties":{"tax_breakdown_id":{"type":"string"},"tax_money":{"$ref":"#/components/schemas/Money"}},"required":["tax_breakdown_id"],"type":"object"},"RegenerateInvoiceLinkResponse":{"properties":{"data":{"$ref":"#/components/schemas/RegenerateInvoiceLinkResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"RegenerateInvoiceLinkResult":{"properties":{"invoice":{"$ref":"#/components/schemas/Invoice"},"public_url":{"type":"string"}},"required":["invoice"],"type":"object"},"ReleaseInventoryReservationRequest":{"properties":{"expected_version":{"description":"Reservation version the caller last read.","format":"int64","type":"integer"},"lines":{"items":{"properties":{"inventory_reservation_line_id":{"description":"Line being transitioned.","type":"string"},"target_released_from_committed_quantity":{"description":"Cumulative quantity released from the committed bucket. Whole-number quantity; fractional quantities are not supported.","format":"int64","minimum":0,"type":"integer"},"target_released_from_held_quantity":{"description":"Cumulative quantity released from the held bucket. Whole-number quantity; fractional quantities are not supported.","format":"int64","minimum":0,"type":"integer"}},"required":["inventory_reservation_line_id"],"type":"object"},"type":"array"}},"required":["lines"],"type":"object"},"ReleaseReturnResolutionRequest":{"additionalProperties":false,"properties":{"expected_version":{"format":"int64","minimum":1,"type":"integer"},"reason":{"enum":["merchant_approved","exception_resolved","other"],"type":"string","x-enum-descriptions":["Merchant approved.","Exception resolved.","Other."],"x-flint-enum":"closed"},"reason_message":{"type":"string"}},"required":["reason"],"type":"object"},"ReleaseReturnResolutionResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnResolution"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"RemoveDiscountsRequest":{"properties":{"order_discount_ids":{"items":{"type":"string"},"type":"array"}},"required":["order_discount_ids"],"type":"object"},"ReopenReturnRequest":{"additionalProperties":false,"properties":{"expected_version":{"format":"int64","minimum":1,"type":"integer"},"reason":{"enum":["linked_effect_changed","correction_required","additional_merchandise_received","merchant_request","other"],"type":"string","x-enum-descriptions":["Linked effect changed.","Correction required.","Additional merchandise received.","Merchant request.","Other."],"x-flint-enum":"closed"},"reason_message":{"type":"string"}},"required":["reason"],"type":"object"},"ReopenReturnResponse":{"properties":{"data":{"$ref":"#/components/schemas/Return"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"Report":{"oneOf":[{"not":{"anyOf":[{"required":["download"]},{"required":["failure_reason"]}]},"properties":{"status":{"enum":["pending"],"type":"string","x-enum-descriptions":["Pending."],"x-flint-enum":"open"}}},{"not":{"required":["failure_reason"]},"properties":{"status":{"enum":["succeeded"],"type":"string","x-enum-descriptions":["Succeeded."],"x-flint-enum":"open"}},"required":["download"]},{"not":{"required":["download"]},"properties":{"status":{"enum":["failed"],"type":"string","x-enum-descriptions":["Failed."],"x-flint-enum":"open"}},"required":["failure_reason"]}],"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"currency":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","readOnly":true,"type":"string"},"download":{"$ref":"#/components/schemas/PublicDownload","readOnly":true},"failure_reason":{"enum":["generation_failed","data_unavailable","limit_exceeded"],"readOnly":true,"type":"string","x-enum-descriptions":["Generation failed.","Data unavailable.","Limit exceeded."],"x-flint-enum":"closed"},"interval_end_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"interval_start_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"report_id":{"pattern":"^rep_[0-9A-HJKMNP-TV-Z]{26}$","readOnly":true,"type":"string"},"report_type":{"description":"The generated report contract. tax_transactions_itemized_v1 contains frozen Quaderno-backed collection and successful refund evidence for reconciliation and import, not filing instructions.","enum":["orders_itemized_v1","payments_itemized_v1","balance_transactions_itemized_v1","payouts_itemized_v1","tax_itemized_v1","tax_summarized_v1","merchant_billing_itemized_v1","tax_transactions_itemized_v1"],"readOnly":true,"type":"string","x-enum-descriptions":["Orders itemized v1.","Payments itemized v1.","Balance transactions itemized v1.","Payouts itemized v1.","Tax itemized v1.","Tax summarized v1.","Merchant billing itemized v1.","Tax transactions itemized v1."],"x-flint-enum":"closed"},"status":{"enum":["pending","succeeded","failed"],"readOnly":true,"type":"string","x-enum-descriptions":["Pending.","Succeeded.","Failed."],"x-flint-enum":"open"},"timezone":{"readOnly":true,"type":"string"}},"required":["created_at","currency","interval_end_at","interval_start_at","report_id","report_type","status","timezone"],"type":"object"},"ReportListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Report"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ReportResponse":{"properties":{"data":{"$ref":"#/components/schemas/Report"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"RequestedTip":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"description":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"percent":{"multipleOf":0.0001,"type":"number"}},"type":"object"},"ResendWebhookDeliveryRequest":{"properties":{"reason":{"type":"string"}},"type":"object"},"ReservationLine":{"properties":{"allocated_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"at_risk_committed_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"at_risk_held_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"bundle_component_id":{"type":"string"},"committed_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"consumed_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"demand_key":{"type":"string"},"geography_revision":{"format":"int64","type":"integer"},"held_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"inventory_item_id":{"type":"string"},"inventory_reservation_line_id":{"type":"string"},"location_id":{"type":"string"},"order_line_item_id":{"type":"string"},"reallocated_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"released_from_committed_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"released_from_held_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"}},"required":["allocated_quantity","at_risk_committed_quantity","at_risk_held_quantity","committed_quantity","consumed_quantity","demand_key","geography_revision","held_quantity","inventory_item_id","inventory_reservation_line_id","location_id","reallocated_quantity","released_from_committed_quantity","released_from_held_quantity"],"type":"object"},"ResolveCustomerDeletionRequest":{"properties":{"decision":{"enum":["approve","reject"],"type":"string","x-enum-descriptions":["Approve.","Reject."],"x-flint-enum":"closed"}},"required":["decision"],"type":"object"},"ResolveOrderInventoryExceptionRequest":{"properties":{"reason":{"type":"string"}},"type":"object"},"ResolvePaymentLinkLineItemModifierInput":{"properties":{"modifier_id":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"text":{"$ref":"#/components/schemas/ResolvePaymentLinkTextModifierInput"}},"type":"object"},"ResolvePaymentLinkLineItemModifiers":{"properties":{"modifiers":{"items":{"$ref":"#/components/schemas/ResolvePaymentLinkLineItemModifierInput"},"type":"array"}},"type":"object"},"ResolvePaymentLinkRequest":{"properties":{"custom_field_values":{"additionalProperties":{"type":"string"},"type":"object"},"modifiers":{"additionalProperties":{"$ref":"#/components/schemas/ResolvePaymentLinkLineItemModifiers"},"type":"object"},"quantity_overrides":{"additionalProperties":{"description":"Whole-number quantity value; fractional quantities are not supported.","format":"int32","type":"integer"},"description":"Map of keys to whole-number quantity overrides; fractional quantities are not supported.","type":"object"},"resolution_context":{"type":"string"},"unit_price_overrides":{"additionalProperties":{"$ref":"#/components/schemas/Money"},"type":"object"}},"required":["resolution_context"],"type":"object"},"ResolvePaymentLinkResponse":{"properties":{"data":{"$ref":"#/components/schemas/CheckoutSessionLaunchResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ResolvePaymentLinkTextModifierInput":{"properties":{"modifier_group_id":{"type":"string"},"value":{"type":"string"}},"required":["modifier_group_id","value"],"type":"object"},"ResourceTimeline":{"properties":{"entries":{"items":{"$ref":"#/components/schemas/ResourceTimelineEntry"},"type":"array"},"environment_id":{"type":"string"},"resource_id":{"type":"string"},"resource_type":{"type":"string"},"test":{"type":"boolean"}},"required":["entries","resource_id","resource_type","test"],"type":"object"},"ResourceTimelineEntry":{"properties":{"api_request_log_id":{"type":"string"},"attempt_number":{"format":"int32","type":"integer"},"automatic_attempt_count":{"format":"int32","type":"integer"},"completed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"correlation_id":{"type":"string"},"delivered_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"delivery_trigger":{"enum":["automatic_delivery","automatic_retry","manual_resend","test_event"],"type":"string","x-enum-descriptions":["Automatic delivery.","Automatic retry.","Manual resend.","Test event."],"x-flint-enum":"closed"},"diagnostic_category":{"enum":["timeout","dns_error","tls_error","connection_error","blocked_target","request_error","http_error"],"type":"string","x-enum-descriptions":["Timeout.","Dns error.","Tls error.","Connection error.","Blocked target.","Request error.","Http error."],"x-flint-enum":"closed"},"duration_milliseconds":{"format":"int64","type":"integer"},"entry_type":{"type":"string"},"environment_id":{"type":"string"},"error_category":{"enum":["authentication","authorization","validation","server_error","rate_limit","idempotency","merchant_readiness","payment","request_error","webhook_timeout","webhook_dns","webhook_tls","webhook_connection","webhook_blocked_target","webhook_request","webhook_http_5xx","webhook_http_4xx","webhook_delivery"],"type":"string","x-enum-descriptions":["Authentication.","Authorization.","Validation.","Server error.","Rate limit.","Idempotency.","Merchant readiness.","Payment.","Request error.","Webhook timeout.","Webhook dns.","Webhook tls.","Webhook connection.","Webhook blocked target.","Webhook request.","Webhook http 5xx.","Webhook http 4xx.","Webhook delivery."],"x-flint-enum":"closed"},"error_code":{"type":"string"},"error_summary":{"type":"string"},"event_source":{"enum":["business_event","test_api"],"type":"string","x-enum-descriptions":["Business event.","Test api."],"x-flint-enum":"closed"},"event_type":{"type":"string"},"http_method":{"type":"string"},"image_revision":{"format":"int64","type":"integer"},"last_error":{"type":"string"},"last_response_code":{"format":"int32","type":"integer"},"latency_milliseconds":{"format":"int64","type":"integer"},"max_attempts":{"format":"int32","type":"integer"},"mutation_kind":{"enum":["replaced"],"type":"string","x-enum-descriptions":["Replaced."],"x-flint-enum":"closed"},"next_retry_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"path":{"type":"string"},"reason":{"type":"string"},"recommended_action":{"type":"string"},"reference_url":{"type":"string"},"request_id":{"type":"string"},"resource_id":{"type":"string"},"resource_timeline_entry_id":{"type":"string"},"resource_type":{"type":"string"},"retryable":{"type":"boolean"},"route_pattern":{"type":"string"},"started_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"status":{"type":"string"},"status_code":{"format":"int32","type":"integer"},"test":{"type":"boolean"},"webhook_delivery_attempt_id":{"type":"string"},"webhook_delivery_id":{"type":"string"},"webhook_endpoint_id":{"type":"string"},"webhook_event_id":{"type":"string"}},"required":["entry_type","occurred_at","resource_timeline_entry_id","test"],"type":"object"},"ResourceTimelineResponse":{"properties":{"data":{"$ref":"#/components/schemas/ResourceTimeline"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ResourceVersionRequest":{"properties":{"expected_version":{"format":"int64","minimum":1,"type":"integer"}},"type":"object"},"ResponseMeta":{"properties":{"api_version":{"type":"string"},"idempotency_replayed":{"type":"boolean"},"request_id":{"type":"string"},"trace_id":{"type":"string"},"warnings":{"items":{"$ref":"#/components/schemas/ResponseWarning"},"type":"array"}},"type":"object"},"ResponseWarning":{"properties":{"code":{"type":"string"},"context":{"additionalProperties":{"type":"string"},"type":"object"},"message":{"type":"string"},"next_actions":{"items":{"$ref":"#/components/schemas/NextAction"},"type":"array"},"observed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"promotion_code":{"description":"Promotion code that was accepted but did not apply, on a promotion_declined warning.","type":"string"},"reason":{"description":"Stable Flint reason code. On a promotion_declined warning this is the promotion decline reason (for example superseded_by_better_offer); an unrecognized value falls back to not_eligible. See the Promotions reference for the full list.","type":"string"},"resource":{"type":"string"},"resource_id":{"type":"string"},"severity":{"type":"string"},"would_have_applied_money":{"$ref":"#/components/schemas/Money","description":"Discount amount this promotion would have applied had it won, on a promotion_declined warning."}},"required":["code","message"],"type":"object"},"RetryReturnDispositionRequest":{"additionalProperties":false,"properties":{"expected_version":{"format":"int64","minimum":1,"type":"integer"},"reason":{"enum":["dependency_recovered","mapping_corrected","operator_retry","other"],"type":"string","x-enum-descriptions":["Dependency recovered.","Mapping corrected.","Operator retry.","Other."],"x-flint-enum":"closed"},"reason_message":{"type":"string"}},"required":["reason"],"type":"object"},"RetryReturnDispositionResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnDisposition"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"RetryReturnResolutionRequest":{"additionalProperties":false,"properties":{"expected_version":{"format":"int64","minimum":1,"type":"integer"},"reason":{"enum":["dependency_recovered","payment_method_updated","operator_retry","other"],"type":"string","x-enum-descriptions":["Dependency recovered.","Payment method updated.","Operator retry.","Other."],"x-flint-enum":"closed"},"reason_message":{"type":"string"}},"required":["reason"],"type":"object"},"RetryReturnResolutionResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnResolution"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"Return":{"properties":{"canceled_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"completed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"completed_by":{"$ref":"#/components/schemas/ReturnActor"},"completion_blockers":{"items":{"$ref":"#/components/schemas/ReturnCompletionBlocker"},"type":"array"},"completion_mode":{"enum":["manual","automatic"],"type":"string","x-enum-descriptions":["Manual.","Automatic."],"x-flint-enum":"closed"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"customer":{"anyOf":[{"$ref":"#/components/schemas/ExpandedCustomerSummary"},{"type":"null"}]},"customer_id":{"type":"string"},"decision_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"decision_status":{"enum":["pending","approved","partially_approved","declined"],"type":"string","x-enum-descriptions":["Pending.","Approved.","Partially approved.","Declined."],"x-flint-enum":"open"},"disposition_count":{"format":"int64","type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"financial_summary":{"$ref":"#/components/schemas/ReturnFinancialSummary"},"handoff_requirements":{"items":{"$ref":"#/components/schemas/ReturnHandoffRequirement"},"type":"array"},"initiated_by":{"enum":["buyer","merchant","integration","system"],"type":"string","x-enum-descriptions":["Buyer.","Merchant.","Integration.","System."],"x-flint-enum":"closed"},"inspection_count":{"format":"int64","type":"integer"},"line_items":{"items":{"$ref":"#/components/schemas/ReturnLineItem"},"type":"array"},"merchandise_status":{"enum":["not_required","awaiting_handoff","in_transit","partially_received","received","inspection_required","partially_inspected","inspection_review_required","disposition_required","resolved","exception"],"type":"string","x-enum-descriptions":["Not required.","Awaiting handoff.","In transit.","Partially received.","Received.","Inspection required.","Partially inspected.","Inspection review required.","Disposition required.","Resolved.","Exception."],"x-flint-enum":"open"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrderSummary"},{"type":"null"}]},"order_id":{"type":"string"},"policy_evaluation":{"$ref":"#/components/schemas/ReturnPolicyEvaluation"},"receipt_count":{"format":"int64","type":"integer"},"resolution_count":{"format":"int64","type":"integer"},"resolution_status":{"enum":["not_selected","pending","partially_fulfilled","requires_action","fulfilled","failed"],"type":"string","x-enum-descriptions":["Not selected.","Pending.","Partially fulfilled.","Requires action.","Fulfilled.","Failed."],"x-flint-enum":"open"},"return_id":{"type":"string"},"return_number":{"type":"string"},"shipment_count":{"format":"int64","type":"integer"},"status":{"enum":["requested","open","completed","declined","canceled"],"type":"string","x-enum-descriptions":["Requested.","Open.","Completed.","Declined.","Canceled."],"x-flint-enum":"open"},"supported_actions":{"items":{"type":"string"},"type":"array"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"version":{"format":"int64","minimum":0,"type":"integer"}},"required":["completion_blockers","created_at","decision_status","disposition_count","financial_summary","handoff_requirements","initiated_by","inspection_count","line_items","merchandise_status","metadata","order_id","receipt_count","resolution_count","resolution_status","return_id","return_number","status","supported_actions","updated_at","version"],"type":"object"},"ReturnActor":{"properties":{"actor_id":{"type":"string"},"actor_type":{"enum":["buyer","merchant","integration","system"],"type":"string","x-enum-descriptions":["Buyer.","Merchant.","Integration.","System."],"x-flint-enum":"closed"}},"required":["actor_type"],"type":"object"},"ReturnCompletionBlocker":{"properties":{"code":{"description":"What is still owed before this Return can complete. Each blocker names the Return line it belongs to and, where one exists, the receipt, inspection, disposition, or resolution holding it up. An empty completion_blockers array means nothing is outstanding.","enum":["decision_pending","handoff_pending","receipt_pending","inspection_pending","inspection_review_required","disposition_required","resolution_not_selected","resolution_pending","resolution_requires_action","resolution_failed","merchandise_exception"],"type":"string","x-enum-descriptions":["Decision pending.","Handoff pending.","Receipt pending.","Inspection pending.","Inspection review required.","Disposition required.","Resolution not selected.","Resolution pending.","Resolution requires action.","Resolution failed.","Merchandise exception."],"x-flint-enum":"closed"},"message":{"type":"string"},"return_disposition_id":{"type":"string"},"return_inspection_id":{"type":"string"},"return_line_item_id":{"type":"string"},"return_receipt_id":{"type":"string"},"return_resolution_id":{"type":"string"},"shipment_id":{"type":"string"}},"required":["code","message"],"type":"object"},"ReturnDisposition":{"properties":{"canceled_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"created_by":{"$ref":"#/components/schemas/ReturnActor"},"disposition_type":{"enum":["sellable","quality_control","damaged","quarantined","repair","refurbish","liquidate","donate","discard","return_to_buyer","lost"],"type":"string","x-enum-descriptions":["Sellable.","Quality control.","Damaged.","Quarantined.","Repair.","Refurbish.","Liquidate.","Donate.","Discard.","Return to buyer.","Lost."],"x-flint-enum":"closed"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"failure_code":{"type":"string"},"failure_message":{"type":"string"},"inventory_location_id":{"type":"string"},"inventory_movement_ids":{"items":{"type":"string"},"type":"array"},"inventory_receipt_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"reason":{"enum":["inspection_result","return_policy","warehouse_override","safety_requirement","other"],"type":"string","x-enum-descriptions":["Inspection result.","Return policy.","Warehouse override.","Safety requirement.","Other."],"x-flint-enum":"closed"},"reason_message":{"type":"string"},"replaced_by_return_disposition_id":{"type":"string"},"replaces_return_disposition_id":{"type":"string"},"return_disposition_id":{"type":"string"},"return_id":{"type":"string"},"return_inspection_line_item_id":{"type":"string"},"return_line_item_id":{"type":"string"},"return_receipt_line_item_id":{"type":"string"},"status":{"enum":["pending","succeeded","failed","canceled"],"type":"string","x-enum-descriptions":["Pending.","Succeeded.","Failed.","Canceled."],"x-flint-enum":"open"},"supported_actions":{"items":{"type":"string"},"type":"array"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"version":{"format":"int64","minimum":0,"type":"integer"}},"required":["created_at","created_by","disposition_type","inventory_movement_ids","metadata","occurred_at","quantity","reason","return_disposition_id","return_id","status","supported_actions","updated_at","version"],"type":"object"},"ReturnEligibilityCheck":{"properties":{"evaluated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"line_items":{"items":{"$ref":"#/components/schemas/ReturnEligibilityCheckLineItem"},"type":"array"},"order_id":{"type":"string"},"policy_evaluation":{"$ref":"#/components/schemas/ReturnPolicyEvaluation"},"selection":{"$ref":"#/components/schemas/ReturnEligibilitySelection"},"status":{"enum":["eligible","ineligible","review_required"],"type":"string","x-enum-descriptions":["Eligible.","Ineligible.","Review required."],"x-flint-enum":"open"}},"required":["evaluated_at","line_items","order_id","policy_evaluation","selection","status"],"type":"object"},"ReturnEligibilityCheckLineItem":{"properties":{"bundle_components":{"items":{"$ref":"#/components/schemas/BundleComponent"},"type":"array"},"bundle_id":{"type":"string"},"description":{"type":"string"},"eligibility":{"$ref":"#/components/schemas/ReturnLineItemEligibility"},"fulfillment_id":{"type":"string"},"image":{"$ref":"#/components/schemas/Image"},"is_self_service_enabled":{"type":"boolean"},"modifiers":{"items":{"$ref":"#/components/schemas/OrderLineItemModifier"},"type":"array"},"name":{"type":"string"},"order_line_item_id":{"type":"string"},"product_id":{"type":"string"},"requested_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"selected_options":{"items":{"$ref":"#/components/schemas/SelectedProductOption"},"type":"array"},"sku":{"type":"string"},"suggested_return_reasons":{"items":{"$ref":"#/components/schemas/ReturnReasonSummary"},"maxItems":20,"type":"array"},"variant_id":{"type":"string"}},"required":["bundle_components","eligibility","fulfillment_id","is_self_service_enabled","modifiers","name","order_line_item_id","selected_options","suggested_return_reasons"],"type":"object"},"ReturnEligibilitySelection":{"additionalProperties":false,"discriminator":{"propertyName":"selection_type"},"oneOf":[{"not":{"required":["line_items"]},"properties":{"selection_type":{"enum":["all_remaining_fulfilled"],"x-enum-descriptions":["All remaining fulfilled."],"x-flint-enum":"closed"}},"required":["selection_type"]},{"properties":{"line_items":{"minItems":1},"selection_type":{"enum":["line_items"],"x-enum-descriptions":["Line items."],"x-flint-enum":"closed"}},"required":["selection_type","line_items"]}],"properties":{"line_items":{"items":{"$ref":"#/components/schemas/ReturnLineItemInput"},"type":"array"},"selection_type":{"enum":["all_remaining_fulfilled","line_items"],"type":"string","x-enum-descriptions":["All remaining fulfilled.","Line items."],"x-flint-enum":"closed"}},"required":["selection_type"],"type":"object"},"ReturnFinancialSummary":{"properties":{"collected_money":{"$ref":"#/components/schemas/Money"},"credit_money":{"$ref":"#/components/schemas/Money"},"deduction_money":{"$ref":"#/components/schemas/Money"},"due_from_buyer_money":{"$ref":"#/components/schemas/Money"},"due_to_buyer_money":{"$ref":"#/components/schemas/Money"},"refunded_money":{"$ref":"#/components/schemas/Money"},"replacement_total_money":{"$ref":"#/components/schemas/Money"},"returned_discount_money":{"$ref":"#/components/schemas/Money"},"returned_subtotal_money":{"$ref":"#/components/schemas/Money"},"returned_tax_money":{"$ref":"#/components/schemas/Money"},"returned_total_money":{"$ref":"#/components/schemas/Money"}},"required":["collected_money","credit_money","deduction_money","due_from_buyer_money","due_to_buyer_money","refunded_money","replacement_total_money","returned_discount_money","returned_subtotal_money","returned_tax_money","returned_total_money"],"type":"object"},"ReturnHandoffDestination":{"properties":{"address":{"$ref":"#/components/schemas/Address"},"destination_type":{"enum":["buyer_address","location","external_location"],"type":"string","x-enum-descriptions":["Buyer address.","Location.","External location."],"x-flint-enum":"closed"},"location_id":{"type":"string"},"name":{"type":"string"}},"required":["destination_type"],"type":"object"},"ReturnHandoffRequirement":{"properties":{"destination":{"$ref":"#/components/schemas/ReturnHandoffDestination"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"instructions":{"type":"string"},"line_items":{"items":{"$ref":"#/components/schemas/ReturnHandoffRequirementLineItem"},"type":"array"},"shipment_count":{"format":"int64","type":"integer"},"status":{"description":"Whether the buyer has started sending merchandise back. A requirement leaves handoff_requirements entirely once it is satisfied, so there is no terminal status and an empty array means nothing is waiting on the buyer.","enum":["pending","in_progress"],"type":"string","x-enum-descriptions":["Pending.","In progress."],"x-flint-enum":"open"}},"required":["destination","line_items","status"],"type":"object"},"ReturnHandoffRequirementLineItem":{"properties":{"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"return_line_item_id":{"type":"string"}},"required":["quantity","return_line_item_id"],"type":"object"},"ReturnInspection":{"properties":{"correction_reason":{"enum":["entry_error","duplicate_observation","source_correction","reconciliation_correction","other"],"type":"string","x-enum-descriptions":["Entry error.","Duplicate observation.","Source correction.","Reconciliation correction.","Other."],"x-flint-enum":"closed"},"correction_reason_message":{"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"external_actor_id":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"generated_dispositions":{"items":{"$ref":"#/components/schemas/ReturnDisposition"},"type":"array"},"inspected_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"line_items":{"items":{"$ref":"#/components/schemas/ReturnInspectionLineItem"},"type":"array"},"location_id":{"type":"string"},"return_id":{"type":"string"},"return_inspection_id":{"type":"string"},"return_receipt_id":{"type":"string"},"source_system":{"anyOf":[{"$ref":"#/components/schemas/ReturnSourceSystem"},{"type":"null"}]},"status":{"enum":["current","superseded"],"type":"string","x-enum-descriptions":["Current.","Superseded."],"x-flint-enum":"open"},"superseded_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"superseded_by_return_inspection_id":{"type":"string"},"supersedes_return_inspection_id":{"type":"string"}},"required":["created_at","generated_dispositions","inspected_at","line_items","location_id","return_id","return_inspection_id","return_receipt_id","source_system","status"],"type":"object"},"ReturnInspectionLineItem":{"properties":{"acceptance_decided_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"acceptance_decided_by":{"$ref":"#/components/schemas/ReturnActor"},"acceptance_decision_reason":{"enum":["inspection_result","return_policy","manual_review","other"],"type":"string","x-enum-descriptions":["Inspection result.","Return policy.","Manual review.","Other."],"x-flint-enum":"closed"},"acceptance_decision_reason_message":{"type":"string"},"acceptance_status":{"enum":["accepted","rejected","review_required"],"type":"string","x-enum-descriptions":["Accepted.","Rejected.","Review required."],"x-flint-enum":"open"},"available_disposition_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"condition":{"enum":["new","unopened","opened","used","damaged","defective","incomplete","unknown"],"type":"string","x-enum-descriptions":["New.","Unopened.","Opened.","Used.","Damaged.","Defective.","Incomplete.","Unknown."],"x-flint-enum":"closed"},"finding_codes":{"items":{"enum":["matches_expected_item","wrong_item","damaged","defective","used","missing_parts","empty_package","counterfeit_suspected","other"],"type":"string","x-enum-descriptions":["Matches expected item.","Wrong item.","Damaged.","Defective.","Used.","Missing parts.","Empty package.","Counterfeit suspected.","Other."],"x-flint-enum":"closed"},"type":"array"},"internal_note":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"return_inspection_id":{"type":"string"},"return_inspection_line_item_id":{"type":"string"},"return_line_item_id":{"type":"string"},"return_receipt_line_item_id":{"type":"string"},"supported_actions":{"items":{"type":"string"},"type":"array"}},"required":["acceptance_status","available_disposition_quantity","condition","finding_codes","quantity","return_inspection_id","return_inspection_line_item_id","return_receipt_line_item_id","supported_actions"],"type":"object"},"ReturnInspectionLineItemInput":{"additionalProperties":false,"properties":{"acceptance_status":{"enum":["accepted","rejected","review_required"],"type":"string","x-enum-descriptions":["Accepted.","Rejected.","Review required."],"x-flint-enum":"open"},"condition":{"enum":["new","unopened","opened","used","damaged","defective","incomplete","unknown"],"type":"string","x-enum-descriptions":["New.","Unopened.","Opened.","Used.","Damaged.","Defective.","Incomplete.","Unknown."],"x-flint-enum":"closed"},"finding_codes":{"items":{"enum":["matches_expected_item","wrong_item","damaged","defective","used","missing_parts","empty_package","counterfeit_suspected","other"],"type":"string","x-enum-descriptions":["Matches expected item.","Wrong item.","Damaged.","Defective.","Used.","Missing parts.","Empty package.","Counterfeit suspected.","Other."],"x-flint-enum":"closed"},"type":"array"},"internal_note":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"return_line_item_id":{"type":"string"},"return_receipt_line_item_id":{"type":"string"},"verification_reason":{"enum":["order_match_confirmed","sku_match_confirmed","inspection_confirmed","merchant_review","other"],"type":"string","x-enum-descriptions":["Order match confirmed.","Sku match confirmed.","Inspection confirmed.","Merchant review.","Other."],"x-flint-enum":"closed"},"verification_reason_message":{"type":"string"}},"required":["acceptance_status","condition","quantity","return_receipt_line_item_id"],"type":"object"},"ReturnLineDecision":{"additionalProperties":false,"allOf":[{"anyOf":[{"not":{"required":["decline_reason_message"]}},{"required":["decline_reason"]}]},{"anyOf":[{"not":{"required":["override_reason_message"]}},{"required":["override_reason"]}]},{"if":{"properties":{"selected_resolution_type":{"const":"refund"}},"required":["selected_resolution_type"]},"then":{"properties":{"allowed_resolution_types":{"contains":{"const":"refund"},"type":"array"}},"required":["allowed_resolution_types"]}},{"if":{"properties":{"selected_resolution_type":{"const":"exchange"}},"required":["selected_resolution_type"]},"then":{"properties":{"allowed_resolution_types":{"contains":{"const":"exchange"},"type":"array"}},"required":["allowed_resolution_types"]}},{"if":{"properties":{"selected_resolution_type":{"const":"replacement"}},"required":["selected_resolution_type"]},"then":{"properties":{"allowed_resolution_types":{"contains":{"const":"replacement"},"type":"array"}},"required":["allowed_resolution_types"]}},{"if":{"properties":{"selected_resolution_type":{"const":"no_monetary_action"}},"required":["selected_resolution_type"]},"then":{"properties":{"allowed_resolution_types":{"contains":{"const":"no_monetary_action"},"type":"array"}},"required":["allowed_resolution_types"]}}],"discriminator":{"propertyName":"decision_basis"},"oneOf":[{"not":{"anyOf":[{"required":["return_required_quantity"]},{"required":["allowed_resolution_types"]},{"required":["selected_resolution_type"]},{"required":["resolution_mode"]},{"required":["refund_timing"]},{"required":["is_inspection_required"]},{"required":["receiving_location_id"]},{"required":["override_reason"]},{"required":["override_reason_message"]}]},"properties":{"decision_basis":{"enum":["policy_evaluation"],"x-enum-descriptions":["Policy evaluation."],"x-flint-enum":"closed"}},"required":["decision_basis","approved_quantity"]},{"allOf":[{"anyOf":[{"properties":{"approved_quantity":{"maximum":0},"return_required_quantity":{"maximum":0}}},{"properties":{"allowed_resolution_types":{"minItems":1},"approved_quantity":{"minimum":1}},"required":["allowed_resolution_types","resolution_mode"]}]},{"anyOf":[{"not":{"required":["selected_resolution_type"]},"properties":{"resolution_mode":{"enum":["manual"],"x-enum-descriptions":["Manual."],"x-flint-enum":"closed"}}},{"properties":{"resolution_mode":{"enum":["automatic"],"x-enum-descriptions":["Automatic."],"x-flint-enum":"closed"}},"required":["resolution_mode","selected_resolution_type"]}]},{"anyOf":[{"properties":{"receiving_location_id":{"minLength":1,"pattern":"\\S"},"return_required_quantity":{"minimum":1}},"required":["is_inspection_required","receiving_location_id"]},{"properties":{"is_inspection_required":{"enum":[false],"x-enum-descriptions":["False."],"x-flint-enum":"closed"},"refund_timing":{"enum":["after_approval","manual"],"x-enum-descriptions":["After approval.","Manual."],"x-flint-enum":"closed"},"return_required_quantity":{"maximum":0}}}]},{"anyOf":[{"not":{"properties":{"refund_timing":{"enum":["after_inspection"],"x-enum-descriptions":["After inspection."],"x-flint-enum":"closed"}},"required":["refund_timing"]}},{"properties":{"is_inspection_required":{"enum":[true],"x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"required":["is_inspection_required"]}]}],"properties":{"decision_basis":{"enum":["explicit"],"x-enum-descriptions":["Explicit."],"x-flint-enum":"closed"}},"required":["decision_basis","approved_quantity","return_required_quantity"]}],"properties":{"allowed_resolution_types":{"items":{"enum":["refund","exchange","replacement","no_monetary_action"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action."],"x-flint-enum":"closed"},"type":"array"},"approved_quantity":{"description":"Whole-number quantity; fractional quantities are not supported. Approved quantity ranges from zero through the return line's requested_quantity. Declining any requested quantity requires decline_reason; decline context is invalid when all requested quantity is approved.","format":"int64","minimum":0,"type":"integer"},"decision_basis":{"description":"Which decision semantics this line uses. With policy_evaluation you accept the recorded policy proposal and send only approved_quantity plus decline context; the explicit fields are rejected. With explicit you state the outcome yourself and return_required_quantity is required, and approving any quantity also requires allowed_resolution_types and resolution_mode. A resolution_mode of automatic additionally requires selected_resolution_type, and any return_required_quantity above 0 additionally requires a receiving_location_id whose Location has a postal address.","enum":["policy_evaluation","explicit"],"type":"string","x-enum-descriptions":["Policy evaluation.","Explicit."],"x-flint-enum":"closed"},"decline_reason":{"enum":["not_eligible","quantity_unavailable","evidence_missing","suspected_abuse","merchant_discretion","other"],"type":"string","x-enum-descriptions":["Not eligible.","Quantity unavailable.","Evidence missing.","Suspected abuse.","Merchant discretion.","Other."],"x-flint-enum":"closed"},"decline_reason_message":{"type":"string"},"is_inspection_required":{"type":"boolean"},"override_reason":{"description":"Required when an explicit decision changes a valid policy proposal. Invalid without a policy to override.","enum":["customer_service_exception","policy_correction","risk_review","merchant_discretion","other"],"type":"string","x-enum-descriptions":["Customer service exception.","Policy correction.","Risk review.","Merchant discretion.","Other."],"x-flint-enum":"closed"},"override_reason_message":{"type":"string"},"receiving_location_id":{"type":"string"},"refund_timing":{"enum":["after_approval","after_handoff","after_receipt","after_inspection","manual"],"type":"string","x-enum-descriptions":["After approval.","After handoff.","After receipt.","After inspection.","Manual."],"x-flint-enum":"closed"},"resolution_mode":{"enum":["automatic","manual"],"type":"string","x-enum-descriptions":["Automatic.","Manual."],"x-flint-enum":"closed"},"return_line_item_id":{"type":"string"},"return_required_quantity":{"description":"How much of the approved quantity the buyer must physically send back; fractional quantities are not supported. Set 0 for a returnless refund, where the buyer keeps the merchandise and the Return still settles the money.","format":"int64","minimum":0,"type":"integer"},"selected_resolution_type":{"enum":["refund","exchange","replacement","no_monetary_action"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action."],"x-flint-enum":"closed"}},"required":["approved_quantity","decision_basis","return_line_item_id"],"type":"object"},"ReturnLineItem":{"properties":{"accepted_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"allowed_resolution_types":{"items":{"enum":["refund","exchange","replacement","no_monetary_action"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action."],"x-flint-enum":"closed"},"type":"array"},"approved_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"available_resolution_quantity":{"description":"Approved quantity that can still be assigned to a new resolution. Every non-canceled resolution reserves its line quantity, including proposed, pending, action-required, failed, and fulfilled resolutions. Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"bundle_components":{"items":{"$ref":"#/components/schemas/BundleComponent"},"type":"array"},"bundle_id":{"type":"string"},"buyer_note":{"type":"string"},"canceled_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"decided_by":{"$ref":"#/components/schemas/ReturnActor"},"decision_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"decline_reason":{"enum":["not_eligible","quantity_unavailable","evidence_missing","suspected_abuse","merchant_discretion","other"],"type":"string","x-enum-descriptions":["Not eligible.","Quantity unavailable.","Evidence missing.","Suspected abuse.","Merchant discretion.","Other."],"x-flint-enum":"closed"},"decline_reason_message":{"type":"string"},"declined_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"description":{"type":"string"},"dispositioned_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"eligibility":{"$ref":"#/components/schemas/ReturnLineItemEligibility"},"fulfillment":{"anyOf":[{"$ref":"#/components/schemas/Fulfillment"},{"type":"null"}]},"fulfillment_id":{"type":"string"},"handed_off_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"image":{"$ref":"#/components/schemas/Image"},"inspected_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"inspection_waived_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"inspection_waived_by":{"$ref":"#/components/schemas/ReturnActor"},"inspection_waiver_reason":{"enum":["policy_override","trusted_in_store_handoff","merchant_review","other"],"type":"string","x-enum-descriptions":["Policy override.","Trusted in store handoff.","Merchant review.","Other."],"x-flint-enum":"closed"},"inspection_waiver_reason_message":{"type":"string"},"is_inspection_required":{"type":"boolean"},"is_policy_overridden":{"type":"boolean"},"merchandise_status":{"enum":["not_required","awaiting_handoff","in_transit","partially_received","received","inspection_required","partially_inspected","inspection_review_required","disposition_required","resolved","exception"],"type":"string","x-enum-descriptions":["Not required.","Awaiting handoff.","In transit.","Partially received.","Received.","Inspection required.","Partially inspected.","Inspection review required.","Disposition required.","Resolved.","Exception."],"x-flint-enum":"open"},"modifiers":{"items":{"$ref":"#/components/schemas/OrderLineItemModifier"},"type":"array"},"name":{"type":"string"},"order_line_item_id":{"type":"string"},"overridden_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"overridden_by":{"$ref":"#/components/schemas/ReturnActor"},"override_reason":{"enum":["customer_service_exception","policy_correction","risk_review","merchant_discretion","other"],"type":"string","x-enum-descriptions":["Customer service exception.","Policy correction.","Risk review.","Merchant discretion.","Other."],"x-flint-enum":"closed"},"override_reason_message":{"type":"string"},"product_id":{"type":"string"},"received_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"receiving_location_id":{"type":"string"},"refund_timing":{"enum":["after_approval","after_handoff","after_receipt","after_inspection","manual"],"type":"string","x-enum-descriptions":["After approval.","After handoff.","After receipt.","After inspection.","Manual."],"x-flint-enum":"closed"},"rejected_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"requested_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"requested_resolution_type":{"enum":["refund","exchange","replacement","no_monetary_action","correction"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action.","Correction."],"x-flint-enum":"closed"},"resolution_count":{"format":"int64","type":"integer"},"resolution_mode":{"enum":["automatic","manual"],"type":"string","x-enum-descriptions":["Automatic.","Manual."],"x-flint-enum":"closed"},"resolution_status":{"enum":["not_selected","pending","partially_fulfilled","requires_action","fulfilled","failed"],"type":"string","x-enum-descriptions":["Not selected.","Pending.","Partially fulfilled.","Requires action.","Fulfilled.","Failed."],"x-flint-enum":"open"},"resolved_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"return_id":{"type":"string"},"return_line_item_id":{"type":"string"},"return_reason":{"anyOf":[{"$ref":"#/components/schemas/ReturnReason"},{"type":"null"}]},"return_reason_handle":{"type":"string"},"return_reason_id":{"type":"string"},"return_reason_name":{"type":"string"},"return_required_quantity":{"description":"How much of the approved quantity the buyer must physically send back; fractional quantities are not supported. Set 0 for a returnless refund, where the buyer keeps the merchandise and the Return still settles the money.","format":"int64","type":"integer"},"return_value":{"$ref":"#/components/schemas/ReturnLineItemValue"},"review_required_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"selected_options":{"items":{"$ref":"#/components/schemas/SelectedProductOption"},"type":"array"},"selected_resolution_type":{"enum":["refund","exchange","replacement","no_monetary_action"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action."],"x-flint-enum":"closed"},"sku":{"type":"string"},"status":{"enum":["requested","open","completed","declined","canceled"],"type":"string","x-enum-descriptions":["Requested.","Open.","Completed.","Declined.","Canceled."],"x-flint-enum":"open"},"supported_actions":{"items":{"type":"string"},"type":"array"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"variant_id":{"type":"string"}},"required":["accepted_quantity","allowed_resolution_types","approved_quantity","available_resolution_quantity","bundle_components","canceled_quantity","created_at","declined_quantity","dispositioned_quantity","eligibility","fulfillment_id","handed_off_quantity","inspected_quantity","is_policy_overridden","merchandise_status","modifiers","name","order_line_item_id","received_quantity","rejected_quantity","requested_quantity","resolution_count","resolution_status","resolved_quantity","return_id","return_line_item_id","return_reason_handle","return_reason_id","return_reason_name","return_required_quantity","return_value","review_required_quantity","selected_options","status","supported_actions","updated_at"],"type":"object"},"ReturnLineItemDecisionProposal":{"properties":{"allowed_resolution_types":{"items":{"enum":["refund","exchange","replacement","no_monetary_action"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action."],"x-flint-enum":"closed"},"type":"array"},"based_on_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"is_inspection_required":{"type":"boolean"},"receiving_location_id":{"type":"string"},"refund_timing":{"enum":["after_approval","after_handoff","after_receipt","after_inspection","manual"],"type":"string","x-enum-descriptions":["After approval.","After handoff.","After receipt.","After inspection.","Manual."],"x-flint-enum":"closed"},"resolution_mode":{"enum":["automatic","manual"],"type":"string","x-enum-descriptions":["Automatic.","Manual."],"x-flint-enum":"closed"},"return_required_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"selected_resolution_type":{"enum":["refund","exchange","replacement","no_monetary_action"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action."],"x-flint-enum":"closed"}},"required":["allowed_resolution_types","based_on_quantity","is_inspection_required","resolution_mode","return_required_quantity"],"type":"object"},"ReturnLineItemEligibility":{"properties":{"allowed_resolution_types":{"items":{"enum":["refund","exchange","replacement","no_monetary_action"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action."],"x-flint-enum":"closed"},"type":"array"},"decision_proposal":{"$ref":"#/components/schemas/ReturnLineItemDecisionProposal"},"eligible_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"evaluated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"policy_adjustment_proposals":{"items":{"$ref":"#/components/schemas/ReturnPolicyAdjustmentProposal"},"type":"array"},"reason":{"enum":["eligible_under_policy","manual_review_required","return_window_expired","quantity_unavailable","policy_ineligible","resolution_not_allowed","reason_not_allowed","policy_conflict","no_matching_policy"],"type":"string","x-enum-descriptions":["Eligible under policy.","Manual review required.","Return window expired.","Quantity unavailable.","Policy ineligible.","Resolution not allowed.","Reason not allowed.","Policy conflict.","No matching policy."],"x-flint-enum":"closed"},"reason_message":{"type":"string"},"return_policy_id":{"type":"string"},"return_policy_revision_id":{"type":"string"},"status":{"enum":["eligible","ineligible","review_required"],"type":"string","x-enum-descriptions":["Eligible.","Ineligible.","Review required."],"x-flint-enum":"open"}},"required":["allowed_resolution_types","eligible_quantity","policy_adjustment_proposals","reason","reason_message","status"],"type":"object"},"ReturnLineItemInput":{"additionalProperties":false,"properties":{"buyer_note":{"type":"string"},"fulfillment_id":{"type":"string"},"order_line_item_id":{"type":"string"},"requested_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"requested_resolution_type":{"enum":["refund","exchange","replacement","no_monetary_action"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action."],"x-flint-enum":"closed"},"return_reason_id":{"type":"string"}},"required":["order_line_item_id","requested_quantity","return_reason_id"],"type":"object"},"ReturnLineItemValue":{"properties":{"discount_money":{"$ref":"#/components/schemas/Money"},"subtotal_money":{"$ref":"#/components/schemas/Money"},"tax_money":{"$ref":"#/components/schemas/Money"},"total_money":{"$ref":"#/components/schemas/Money"},"unit_price_money":{"$ref":"#/components/schemas/Money"}},"required":["discount_money","subtotal_money","tax_money","total_money","unit_price_money"],"type":"object"},"ReturnPolicy":{"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"current_return_policy_revision_id":{"type":"string"},"current_revision":{"anyOf":[{"$ref":"#/components/schemas/ReturnPolicyRevision"},{"type":"null"}]},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"return_policy_id":{"type":"string"},"status":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"},"supported_actions":{"items":{"type":"string"},"type":"array"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"version":{"format":"int64","minimum":0,"type":"integer"}},"required":["created_at","current_return_policy_revision_id","metadata","name","return_policy_id","status","supported_actions","updated_at","version"],"type":"object"},"ReturnPolicyAdjustmentProposal":{"properties":{"adjustment_type":{"enum":["return_shipping_fee","restocking_fee","other_fee","goodwill_credit","price_correction","other"],"type":"string","x-enum-descriptions":["Return shipping fee.","Restocking fee.","Other fee.","Goodwill credit.","Price correction.","Other."],"x-flint-enum":"closed"},"based_on_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"calculated_amount_money":{"$ref":"#/components/schemas/Money"},"calculation_type":{"enum":["flat","percent"],"type":"string","x-enum-descriptions":["Flat.","Percent."],"x-flint-enum":"closed"},"flat_money":{"$ref":"#/components/schemas/Money"},"percent":{"format":"double","multipleOf":0.0001,"type":"number"},"value_effect":{"enum":["deduction","credit"],"type":"string","x-enum-descriptions":["Deduction.","Credit."],"x-flint-enum":"closed"}},"required":["adjustment_type","calculation_type","value_effect"],"type":"object"},"ReturnPolicyEvaluation":{"properties":{"evaluated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"line_items":{"items":{"$ref":"#/components/schemas/ReturnPolicyEvaluationLineItem"},"type":"array"},"reason":{"enum":["eligible_under_policy","manual_review_required","return_window_expired","quantity_unavailable","policy_ineligible","resolution_not_allowed","reason_not_allowed","policy_conflict","no_matching_policy"],"type":"string","x-enum-descriptions":["Eligible under policy.","Manual review required.","Return window expired.","Quantity unavailable.","Policy ineligible.","Resolution not allowed.","Reason not allowed.","Policy conflict.","No matching policy."],"x-flint-enum":"closed"},"reason_message":{"type":"string"},"return_policy_id":{"type":"string"},"return_policy_revision_id":{"type":"string"},"status":{"enum":["eligible","ineligible","review_required"],"type":"string","x-enum-descriptions":["Eligible.","Ineligible.","Review required."],"x-flint-enum":"open"}},"required":["line_items","reason","reason_message","status"],"type":"object"},"ReturnPolicyEvaluationLineItem":{"properties":{"allowed_resolution_types":{"items":{"enum":["refund","exchange","replacement","no_monetary_action"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action."],"x-flint-enum":"closed"},"type":"array"},"bundle_components":{"items":{"$ref":"#/components/schemas/BundleComponent"},"type":"array"},"bundle_id":{"type":"string"},"description":{"type":"string"},"eligible_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"fulfillment_id":{"type":"string"},"image":{"$ref":"#/components/schemas/Image"},"is_inspection_required":{"type":"boolean"},"is_merchandise_return_required":{"type":"boolean"},"modifiers":{"items":{"$ref":"#/components/schemas/OrderLineItemModifier"},"type":"array"},"name":{"type":"string"},"order_line_item_id":{"type":"string"},"policy_adjustment_proposals":{"items":{"$ref":"#/components/schemas/ReturnPolicyAdjustmentProposal"},"type":"array"},"product_id":{"type":"string"},"reason":{"enum":["eligible_under_policy","manual_review_required","return_window_expired","quantity_unavailable","policy_ineligible","resolution_not_allowed","reason_not_allowed","policy_conflict","no_matching_policy"],"type":"string","x-enum-descriptions":["Eligible under policy.","Manual review required.","Return window expired.","Quantity unavailable.","Policy ineligible.","Resolution not allowed.","Reason not allowed.","Policy conflict.","No matching policy."],"x-flint-enum":"closed"},"receiving_location_id":{"type":"string"},"refund_timing":{"enum":["after_approval","after_handoff","after_receipt","after_inspection","manual"],"type":"string","x-enum-descriptions":["After approval.","After handoff.","After receipt.","After inspection.","Manual."],"x-flint-enum":"closed"},"requested_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"selected_options":{"items":{"$ref":"#/components/schemas/SelectedProductOption"},"type":"array"},"sku":{"type":"string"},"status":{"enum":["eligible","ineligible","review_required"],"type":"string","x-enum-descriptions":["Eligible.","Ineligible.","Review required."],"x-flint-enum":"open"},"suggested_return_reason_ids":{"items":{"type":"string"},"type":"array"},"variant_id":{"type":"string"}},"required":["allowed_resolution_types","bundle_components","eligible_quantity","fulfillment_id","is_inspection_required","is_merchandise_return_required","modifiers","name","order_line_item_id","policy_adjustment_proposals","reason","refund_timing","requested_quantity","selected_options","status","suggested_return_reason_ids"],"type":"object"},"ReturnPolicyRevision":{"properties":{"allowed_resolution_types":{"items":{"enum":["refund","exchange","replacement","no_monetary_action"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action."],"x-flint-enum":"closed"},"type":"array"},"approval_mode":{"enum":["automatic","manual"],"type":"string","x-enum-descriptions":["Automatic.","Manual."],"x-flint-enum":"closed"},"automatic_resolution_type":{"enum":["refund","exchange","replacement","no_monetary_action"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action."],"x-flint-enum":"closed"},"completion_mode":{"enum":["manual","automatic"],"type":"string","x-enum-descriptions":["Manual.","Automatic."],"x-flint-enum":"closed"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"effective_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"eligibility_result":{"enum":["eligible","ineligible","review_required"],"type":"string","x-enum-descriptions":["Eligible.","Ineligible.","Review required."],"x-flint-enum":"closed"},"ineligibility_reason":{"enum":["final_sale","product_excluded","category_excluded","market_restricted","channel_restricted","outside_return_window","other"],"type":"string","x-enum-descriptions":["Final sale.","Product excluded.","Category excluded.","Market restricted.","Channel restricted.","Outside return window.","Other."],"x-flint-enum":"closed"},"is_inspection_required":{"type":"boolean"},"is_merchandise_return_required":{"type":"boolean"},"priority":{"format":"int32","type":"integer"},"receipt_disposition_mode":{"default":"automatic","description":"Controls verified merchandise after receipt. automatic creates a successful sellable disposition at the receiving location. For tracked merchandise, it also creates an inventory receipt and movement. Untracked merchandise has no inventory effect. If the Return line requires inspection, creation waits for an accepted inspection. manual leaves inventory unchanged until an explicit disposition succeeds. When omitted, the value defaults to automatic.","enum":["automatic","manual"],"type":"string","x-enum-descriptions":["Automatic.","Manual."],"x-flint-enum":"closed"},"receiving_location_id":{"type":"string"},"refund_timing":{"enum":["after_approval","after_handoff","after_receipt","after_inspection","manual"],"type":"string","x-enum-descriptions":["After approval.","After handoff.","After receipt.","After inspection.","Manual."],"x-flint-enum":"closed"},"resolution_mode":{"enum":["automatic","manual"],"type":"string","x-enum-descriptions":["Automatic.","Manual."],"x-flint-enum":"closed"},"resolution_selection_mode":{"enum":["policy_default","buyer_requested"],"type":"string","x-enum-descriptions":["Policy default.","Buyer requested."],"x-flint-enum":"closed"},"restocking_fee":{"$ref":"#/components/schemas/ReturnRestockingFeePolicy"},"return_policy_id":{"type":"string"},"return_policy_revision_id":{"type":"string"},"return_shipping":{"$ref":"#/components/schemas/ReturnShippingPolicy"},"return_window":{"$ref":"#/components/schemas/ReturnWindow"},"scope":{"$ref":"#/components/schemas/ReturnPolicyScope"}},"required":["allowed_resolution_types","approval_mode","created_at","eligibility_result","is_merchandise_return_required","priority","receipt_disposition_mode","return_policy_id","return_policy_revision_id","scope"],"type":"object"},"ReturnPolicyRevisionInput":{"additionalProperties":false,"discriminator":{"propertyName":"eligibility_result"},"if":{"properties":{"allowed_resolution_types":{"contains":{"const":"refund"},"type":"array"}},"required":["allowed_resolution_types"]},"oneOf":[{"not":{"anyOf":[{"required":["allowed_resolution_types"]},{"required":["resolution_mode"]},{"required":["refund_timing"]},{"required":["completion_mode"]}]},"properties":{"eligibility_result":{"enum":["ineligible"],"x-enum-descriptions":["Ineligible."],"x-flint-enum":"closed"}},"required":["eligibility_result"]},{"allOf":[{"anyOf":[{"not":{"anyOf":[{"required":["resolution_selection_mode"]},{"required":["automatic_resolution_type"]}]},"properties":{"resolution_mode":{"enum":["manual"],"x-enum-descriptions":["Manual."],"x-flint-enum":"closed"}}},{"properties":{"resolution_mode":{"enum":["automatic"],"x-enum-descriptions":["Automatic."],"x-flint-enum":"closed"}},"required":["resolution_selection_mode"]}]},{"anyOf":[{"properties":{"is_merchandise_return_required":{"enum":[false],"x-enum-descriptions":["False."],"x-flint-enum":"closed"}}},{"properties":{"is_merchandise_return_required":{"enum":[true],"x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"required":["receiving_location_id"]}]}],"properties":{"eligibility_result":{"enum":["eligible","review_required"],"x-enum-descriptions":["Eligible.","Review required."],"x-flint-enum":"closed"}},"required":["eligibility_result","allowed_resolution_types","resolution_mode","completion_mode"]}],"properties":{"allowed_resolution_types":{"items":{"enum":["refund","exchange","replacement","no_monetary_action"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action."],"x-flint-enum":"closed"},"type":"array"},"approval_mode":{"enum":["automatic","manual"],"type":"string","x-enum-descriptions":["Automatic.","Manual."],"x-flint-enum":"closed"},"automatic_resolution_type":{"enum":["refund","exchange","replacement","no_monetary_action"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action."],"x-flint-enum":"closed"},"completion_mode":{"enum":["manual","automatic"],"type":"string","x-enum-descriptions":["Manual.","Automatic."],"x-flint-enum":"closed"},"eligibility_result":{"description":"Whether merchandise matching this scope may be returned. An ineligible revision commits no resolution behavior: allowed_resolution_types, resolution_mode, refund_timing, and completion_mode must all be omitted. Eligible and review_required revisions require allowed_resolution_types, resolution_mode, and completion_mode.","enum":["eligible","ineligible","review_required"],"type":"string","x-enum-descriptions":["Eligible.","Ineligible.","Review required."],"x-flint-enum":"closed"},"ineligibility_reason":{"enum":["final_sale","product_excluded","category_excluded","market_restricted","channel_restricted","outside_return_window","other"],"type":"string","x-enum-descriptions":["Final sale.","Product excluded.","Category excluded.","Market restricted.","Channel restricted.","Outside return window.","Other."],"x-flint-enum":"closed"},"is_inspection_required":{"type":"boolean"},"is_merchandise_return_required":{"type":"boolean"},"priority":{"format":"int32","type":"integer"},"receipt_disposition_mode":{"default":"automatic","description":"Controls verified merchandise after receipt. automatic creates a successful sellable disposition at the receiving location. For tracked merchandise, it also creates an inventory receipt and movement. Untracked merchandise has no inventory effect. If the Return line requires inspection, creation waits for an accepted inspection. manual leaves inventory unchanged until an explicit disposition succeeds. When omitted, the value defaults to automatic.","enum":["automatic","manual"],"type":"string","x-enum-descriptions":["Automatic.","Manual."],"x-flint-enum":"closed"},"receiving_location_id":{"description":"Where returned merchandise is sent. Required when is_merchandise_return_required is true. Presence is checked when the revision is written; whether the Location exists, is active, and carries a postal address is checked when the policy is activated.","type":"string"},"refund_timing":{"description":"When a refund may execute. Required whenever allowed_resolution_types contains refund. after_handoff and after_receipt require is_merchandise_return_required, and after_inspection also requires is_inspection_required.","enum":["after_approval","after_handoff","after_receipt","after_inspection","manual"],"type":"string","x-enum-descriptions":["After approval.","After handoff.","After receipt.","After inspection.","Manual."],"x-flint-enum":"closed"},"resolution_mode":{"enum":["automatic","manual"],"type":"string","x-enum-descriptions":["Automatic.","Manual."],"x-flint-enum":"closed"},"resolution_selection_mode":{"enum":["policy_default","buyer_requested"],"type":"string","x-enum-descriptions":["Policy default.","Buyer requested."],"x-flint-enum":"closed"},"restocking_fee":{"$ref":"#/components/schemas/ReturnRestockingFeePolicy"},"return_shipping":{"$ref":"#/components/schemas/ReturnShippingPolicy"},"return_window":{"$ref":"#/components/schemas/ReturnWindow"},"scope":{"$ref":"#/components/schemas/ReturnPolicyScope"}},"required":["approval_mode","eligibility_result","is_merchandise_return_required","priority","scope"],"then":{"required":["refund_timing"]},"type":"object"},"ReturnPolicyScope":{"additionalProperties":false,"oneOf":[{"properties":{"category_handles":{"maxItems":0},"channel_types":{"maxItems":0},"location_ids":{"maxItems":0},"match_type":{"enum":["all"],"x-enum-descriptions":["All."],"x-flint-enum":"closed"},"product_ids":{"maxItems":0},"variant_ids":{"maxItems":0}}},{"anyOf":[{"properties":{"product_ids":{"minItems":1}},"required":["product_ids"]},{"properties":{"variant_ids":{"minItems":1}},"required":["variant_ids"]},{"properties":{"category_handles":{"minItems":1}},"required":["category_handles"]},{"properties":{"location_ids":{"minItems":1}},"required":["location_ids"]},{"properties":{"channel_types":{"minItems":1}},"required":["channel_types"]}],"properties":{"match_type":{"enum":["include"],"x-enum-descriptions":["Include."],"x-flint-enum":"closed"}}}],"properties":{"category_handles":{"items":{"type":"string"},"type":"array"},"channel_types":{"items":{"type":"string"},"type":"array"},"location_ids":{"items":{"type":"string"},"type":"array"},"match_type":{"enum":["all","include"],"type":"string","x-enum-descriptions":["All.","Include."],"x-flint-enum":"closed"},"product_ids":{"items":{"type":"string"},"type":"array"},"variant_ids":{"items":{"type":"string"},"type":"array"}},"type":"object"},"ReturnProcessDecision":{"additionalProperties":false,"allOf":[{"anyOf":[{"not":{"required":["decline_reason_message"]}},{"required":["decline_reason"]}]},{"anyOf":[{"not":{"required":["override_reason_message"]}},{"required":["override_reason"]}]},{"if":{"properties":{"selected_resolution_type":{"const":"refund"}},"required":["selected_resolution_type"]},"then":{"properties":{"allowed_resolution_types":{"contains":{"const":"refund"},"type":"array"}},"required":["allowed_resolution_types"]}},{"if":{"properties":{"selected_resolution_type":{"const":"exchange"}},"required":["selected_resolution_type"]},"then":{"properties":{"allowed_resolution_types":{"contains":{"const":"exchange"},"type":"array"}},"required":["allowed_resolution_types"]}},{"if":{"properties":{"selected_resolution_type":{"const":"replacement"}},"required":["selected_resolution_type"]},"then":{"properties":{"allowed_resolution_types":{"contains":{"const":"replacement"},"type":"array"}},"required":["allowed_resolution_types"]}},{"if":{"properties":{"selected_resolution_type":{"const":"no_monetary_action"}},"required":["selected_resolution_type"]},"then":{"properties":{"allowed_resolution_types":{"contains":{"const":"no_monetary_action"},"type":"array"}},"required":["allowed_resolution_types"]}}],"discriminator":{"propertyName":"decision_basis"},"oneOf":[{"not":{"anyOf":[{"required":["return_required_quantity"]},{"required":["allowed_resolution_types"]},{"required":["selected_resolution_type"]},{"required":["resolution_mode"]},{"required":["refund_timing"]},{"required":["is_inspection_required"]},{"required":["receiving_location_id"]},{"required":["override_reason"]},{"required":["override_reason_message"]}]},"properties":{"decision_basis":{"enum":["policy_evaluation"],"x-enum-descriptions":["Policy evaluation."],"x-flint-enum":"closed"}},"required":["decision_basis","approved_quantity"]},{"allOf":[{"anyOf":[{"properties":{"approved_quantity":{"maximum":0},"return_required_quantity":{"maximum":0}}},{"properties":{"allowed_resolution_types":{"minItems":1},"approved_quantity":{"minimum":1}},"required":["allowed_resolution_types","resolution_mode"]}]},{"anyOf":[{"not":{"required":["selected_resolution_type"]},"properties":{"resolution_mode":{"enum":["manual"],"x-enum-descriptions":["Manual."],"x-flint-enum":"closed"}}},{"properties":{"resolution_mode":{"enum":["automatic"],"x-enum-descriptions":["Automatic."],"x-flint-enum":"closed"}},"required":["resolution_mode","selected_resolution_type"]}]},{"anyOf":[{"properties":{"receiving_location_id":{"minLength":1,"pattern":"\\S"},"return_required_quantity":{"minimum":1}},"required":["is_inspection_required","receiving_location_id"]},{"properties":{"is_inspection_required":{"enum":[false],"x-enum-descriptions":["False."],"x-flint-enum":"closed"},"refund_timing":{"enum":["after_approval","manual"],"x-enum-descriptions":["After approval.","Manual."],"x-flint-enum":"closed"},"return_required_quantity":{"maximum":0}}}]},{"anyOf":[{"not":{"properties":{"refund_timing":{"enum":["after_inspection"],"x-enum-descriptions":["After inspection."],"x-flint-enum":"closed"}},"required":["refund_timing"]}},{"properties":{"is_inspection_required":{"enum":[true],"x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"required":["is_inspection_required"]}]}],"properties":{"decision_basis":{"enum":["explicit"],"x-enum-descriptions":["Explicit."],"x-flint-enum":"closed"}},"required":["decision_basis","approved_quantity","return_required_quantity"]}],"properties":{"allowed_resolution_types":{"items":{"enum":["refund","exchange","replacement","no_monetary_action"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action."],"x-flint-enum":"closed"},"type":"array"},"approved_quantity":{"description":"Whole-number quantity; fractional quantities are not supported. Approved quantity ranges from zero through the return line's requested_quantity. Declining any requested quantity requires decline_reason; decline context is invalid when all requested quantity is approved.","format":"int64","minimum":0,"type":"integer"},"decision_basis":{"description":"Which decision semantics this line uses. With policy_evaluation you accept the recorded policy proposal and send only approved_quantity plus decline context; the explicit fields are rejected. With explicit you state the outcome yourself and return_required_quantity is required, and approving any quantity also requires allowed_resolution_types and resolution_mode. A resolution_mode of automatic additionally requires selected_resolution_type, and any return_required_quantity above 0 additionally requires a receiving_location_id whose Location has a postal address.","enum":["policy_evaluation","explicit"],"type":"string","x-enum-descriptions":["Policy evaluation.","Explicit."],"x-flint-enum":"closed"},"decline_reason":{"enum":["not_eligible","quantity_unavailable","evidence_missing","suspected_abuse","merchant_discretion","other"],"type":"string","x-enum-descriptions":["Not eligible.","Quantity unavailable.","Evidence missing.","Suspected abuse.","Merchant discretion.","Other."],"x-flint-enum":"closed"},"decline_reason_message":{"type":"string"},"is_inspection_required":{"type":"boolean"},"override_reason":{"description":"Required when an explicit decision changes a valid policy proposal. Invalid without a policy to override.","enum":["customer_service_exception","policy_correction","risk_review","merchant_discretion","other"],"type":"string","x-enum-descriptions":["Customer service exception.","Policy correction.","Risk review.","Merchant discretion.","Other."],"x-flint-enum":"closed"},"override_reason_message":{"type":"string"},"receiving_location_id":{"type":"string"},"refund_timing":{"enum":["after_approval","after_handoff","after_receipt","after_inspection","manual"],"type":"string","x-enum-descriptions":["After approval.","After handoff.","After receipt.","After inspection.","Manual."],"x-flint-enum":"closed"},"resolution_mode":{"enum":["automatic","manual"],"type":"string","x-enum-descriptions":["Automatic.","Manual."],"x-flint-enum":"closed"},"return_required_quantity":{"description":"How much of the approved quantity the buyer must physically send back; fractional quantities are not supported. Set 0 for a returnless refund, where the buyer keeps the merchandise and the Return still settles the money.","format":"int64","minimum":0,"type":"integer"},"selected_resolution_type":{"enum":["refund","exchange","replacement","no_monetary_action"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action."],"x-flint-enum":"closed"}},"required":["approved_quantity","decision_basis"],"type":"object"},"ReturnProcessDispositionInput":{"additionalProperties":false,"properties":{"disposition_type":{"enum":["sellable","quality_control","damaged","quarantined","repair","refurbish","liquidate","donate","discard","return_to_buyer","lost"],"type":"string","x-enum-descriptions":["Sellable.","Quality control.","Damaged.","Quarantined.","Repair.","Refurbish.","Liquidate.","Donate.","Discard.","Return to buyer.","Lost."],"x-flint-enum":"closed"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"inventory_location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"reason":{"enum":["inspection_result","return_policy","warehouse_override","safety_requirement","other"],"type":"string","x-enum-descriptions":["Inspection result.","Return policy.","Warehouse override.","Safety requirement.","Other."],"x-flint-enum":"closed"},"reason_message":{"type":"string"}},"required":["disposition_type","occurred_at","reason"],"type":"object"},"ReturnProcessInspectionInput":{"additionalProperties":false,"properties":{"acceptance_status":{"enum":["accepted","rejected","review_required"],"type":"string","x-enum-descriptions":["Accepted.","Rejected.","Review required."],"x-flint-enum":"open"},"condition":{"enum":["new","unopened","opened","used","damaged","defective","incomplete","unknown"],"type":"string","x-enum-descriptions":["New.","Unopened.","Opened.","Used.","Damaged.","Defective.","Incomplete.","Unknown."],"x-flint-enum":"closed"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"finding_codes":{"items":{"enum":["matches_expected_item","wrong_item","damaged","defective","used","missing_parts","empty_package","counterfeit_suspected","other"],"type":"string","x-enum-descriptions":["Matches expected item.","Wrong item.","Damaged.","Defective.","Used.","Missing parts.","Empty package.","Counterfeit suspected.","Other."],"x-flint-enum":"closed"},"type":"array"},"inspected_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"internal_note":{"type":"string"}},"required":["acceptance_status","condition","inspected_at"],"type":"object"},"ReturnProcessReceiptInput":{"additionalProperties":false,"properties":{"external_actor_id":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"received_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"receiving_location_id":{"type":"string"},"source_system":{"$ref":"#/components/schemas/ReturnSourceSystem"}},"required":["received_at","receiving_location_id"],"type":"object"},"ReturnProcessResolutionInput":{"additionalProperties":false,"properties":{"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"pricing_basis":{"enum":["original_price","current_price","merchant_agreed_price"],"type":"string","x-enum-descriptions":["Original price.","Current price.","Merchant agreed price."],"x-flint-enum":"closed"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"replacement_line_items":{"items":{"$ref":"#/components/schemas/ReturnReplacementLineItemInput"},"type":"array"},"resolution_type":{"enum":["refund","exchange","replacement","no_monetary_action"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action."],"x-flint-enum":"closed"}},"required":["quantity","resolution_type"],"type":"object"},"ReturnProcessResult":{"properties":{"idempotency_key":{"type":"string"},"return":{"$ref":"#/components/schemas/Return"},"return_dispositions":{"items":{"$ref":"#/components/schemas/ReturnDisposition"},"type":"array"},"return_inspections":{"items":{"$ref":"#/components/schemas/ReturnInspection"},"type":"array"},"return_receipts":{"items":{"$ref":"#/components/schemas/ReturnReceipt"},"type":"array"},"return_resolutions":{"items":{"$ref":"#/components/schemas/ReturnResolution"},"type":"array"}},"required":["idempotency_key","return","return_dispositions","return_inspections","return_receipts","return_resolutions"],"type":"object"},"ReturnReason":{"properties":{"category_handles":{"items":{"type":"string"},"type":"array"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"description":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"handle":{"type":"string"},"is_note_required":{"type":"boolean"},"name":{"type":"string"},"return_reason_id":{"type":"string"},"source":{"enum":["flint","merchant"],"type":"string","x-enum-descriptions":["Flint.","Merchant."],"x-flint-enum":"closed"},"status":{"enum":["active","archived"],"type":"string","x-enum-descriptions":["Active.","Archived."],"x-flint-enum":"open"},"supported_actions":{"items":{"type":"string"},"type":"array"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"version":{"format":"int64","minimum":0,"type":"integer"}},"required":["category_handles","created_at","handle","is_note_required","name","return_reason_id","source","status","supported_actions","updated_at","version"],"type":"object"},"ReturnReasonSummary":{"properties":{"handle":{"type":"string"},"is_note_required":{"type":"boolean"},"name":{"type":"string"},"return_reason_id":{"type":"string"}},"required":["handle","is_note_required","name","return_reason_id"],"type":"object"},"ReturnReceipt":{"properties":{"correction_reason":{"enum":["entry_error","duplicate_observation","source_correction","reconciliation_correction","other"],"type":"string","x-enum-descriptions":["Entry error.","Duplicate observation.","Source correction.","Reconciliation correction.","Other."],"x-flint-enum":"closed"},"correction_reason_message":{"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"external_actor_id":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"generated_dispositions":{"items":{"$ref":"#/components/schemas/ReturnDisposition"},"type":"array"},"line_items":{"items":{"$ref":"#/components/schemas/ReturnReceiptLineItem"},"type":"array"},"received_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"receiving_location_id":{"type":"string"},"return_id":{"type":"string"},"return_receipt_id":{"type":"string"},"shipment_id":{"type":"string"},"source_system":{"anyOf":[{"$ref":"#/components/schemas/ReturnSourceSystem"},{"type":"null"}]},"status":{"enum":["current","superseded"],"type":"string","x-enum-descriptions":["Current.","Superseded."],"x-flint-enum":"open"},"superseded_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"superseded_by_return_receipt_id":{"type":"string"},"supersedes_return_receipt_id":{"type":"string"}},"required":["created_at","generated_dispositions","line_items","received_at","receiving_location_id","return_id","return_receipt_id","source_system","status"],"type":"object"},"ReturnReceiptLineItem":{"properties":{"available_disposition_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"return_line_item_id":{"type":"string"},"return_receipt_id":{"type":"string"},"return_receipt_line_item_id":{"type":"string"},"supported_actions":{"items":{"type":"string"},"type":"array"},"unverified_item":{"$ref":"#/components/schemas/ReturnUnverifiedItem"},"verification_reason":{"enum":["order_match_confirmed","sku_match_confirmed","inspection_confirmed","merchant_review","other"],"type":"string","x-enum-descriptions":["Order match confirmed.","Sku match confirmed.","Inspection confirmed.","Merchant review.","Other."],"x-flint-enum":"closed"},"verification_reason_message":{"type":"string"},"verification_status":{"enum":["matched","unverified","excess"],"type":"string","x-enum-descriptions":["Matched.","Unverified.","Excess."],"x-flint-enum":"open"},"verified_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"verified_by":{"$ref":"#/components/schemas/ReturnActor"}},"required":["available_disposition_quantity","quantity","return_receipt_id","return_receipt_line_item_id","supported_actions","verification_status"],"type":"object"},"ReturnReceiptLineItemInput":{"additionalProperties":false,"oneOf":[{"not":{"anyOf":[{"required":["unverified_item"]},{"required":["verification_status"]}]},"required":["return_line_item_id"]},{"not":{"anyOf":[{"required":["return_line_item_id"]},{"required":["verification_status"]}]},"required":["unverified_item"]},{"not":{"required":["unverified_item"]},"properties":{"verification_status":{"enum":["excess"],"x-enum-descriptions":["Excess."],"x-flint-enum":"closed"}},"required":["return_line_item_id","verification_status"]}],"properties":{"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"return_line_item_id":{"description":"The expected Return line. Required for matched and explicitly excess merchandise.","type":"string"},"unverified_item":{"$ref":"#/components/schemas/ReturnUnverifiedItem","description":"A buyer or catalog identity observation that has not been matched to a Return line."},"verification_status":{"description":"Set to excess only when the merchandise is known to exceed the committed handback quantity for return_line_item_id. Omit for matched or unverified merchandise.","enum":["excess"],"type":"string","x-enum-descriptions":["Excess."],"x-flint-enum":"open"}},"required":["quantity"],"type":"object"},"ReturnReplacementLineItem":{"properties":{"bundle_id":{"type":"string"},"description":{"type":"string"},"discount_money":{"$ref":"#/components/schemas/Money"},"name":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"return_replacement_line_item_id":{"type":"string"},"return_resolution_id":{"type":"string"},"sku":{"type":"string"},"subtotal_money":{"$ref":"#/components/schemas/Money"},"tax_money":{"$ref":"#/components/schemas/Money"},"total_money":{"$ref":"#/components/schemas/Money"},"unit_price_money":{"$ref":"#/components/schemas/Money"},"variant_id":{"type":"string"}},"required":["discount_money","name","quantity","return_replacement_line_item_id","return_resolution_id","subtotal_money","tax_money","total_money","unit_price_money"],"type":"object"},"ReturnReplacementLineItemInput":{"additionalProperties":false,"oneOf":[{"not":{"anyOf":[{"required":["bundle_id"]},{"required":["name"]}]},"required":["variant_id"]},{"not":{"anyOf":[{"required":["variant_id"]},{"required":["name"]}]},"required":["bundle_id"]},{"not":{"anyOf":[{"required":["variant_id"]},{"required":["bundle_id"]}]},"required":["name"]}],"properties":{"bundle_id":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"sku":{"type":"string"},"unit_price_money":{"$ref":"#/components/schemas/Money"},"variant_id":{"type":"string"}},"required":["quantity"],"type":"object"},"ReturnReplacementLineItemReplacementInput":{"additionalProperties":false,"oneOf":[{"not":{"anyOf":[{"required":["bundle_id"]},{"required":["name"]}]},"required":["variant_id"]},{"not":{"anyOf":[{"required":["variant_id"]},{"required":["name"]}]},"required":["bundle_id"]},{"not":{"anyOf":[{"required":["variant_id"]},{"required":["bundle_id"]}]},"required":["name"]}],"properties":{"bundle_id":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"return_replacement_line_item_id":{"type":"string"},"sku":{"type":"string"},"unit_price_money":{"$ref":"#/components/schemas/Money"},"variant_id":{"type":"string"}},"required":["quantity"],"type":"object"},"ReturnResolution":{"properties":{"action_reason":{"enum":["buyer_payment","buyer_selection","merchant_review","manual_release","linked_effect_retry","other"],"type":"string","x-enum-descriptions":["Buyer payment.","Buyer selection.","Merchant review.","Manual release.","Linked effect retry.","Other."],"x-flint-enum":"closed"},"action_required_by":{"enum":["buyer","merchant","integration"],"type":"string","x-enum-descriptions":["Buyer.","Merchant.","Integration."],"x-flint-enum":"closed"},"adjustments":{"items":{"$ref":"#/components/schemas/ReturnResolutionAdjustment"},"type":"array"},"buyer_payment_amount_money":{"$ref":"#/components/schemas/Money"},"buyer_refund_amount_money":{"$ref":"#/components/schemas/Money"},"canceled_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"confirmed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"confirmed_by":{"$ref":"#/components/schemas/ReturnActor"},"corrects_return_resolution_id":{"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"created_by":{"$ref":"#/components/schemas/ReturnActor"},"credit_money":{"$ref":"#/components/schemas/Money"},"deduction_money":{"$ref":"#/components/schemas/Money"},"execution_blockers":{"items":{"$ref":"#/components/schemas/ReturnResolutionExecutionBlocker"},"type":"array"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"failure_code":{"type":"string"},"failure_message":{"type":"string"},"fulfilled_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"line_items":{"items":{"$ref":"#/components/schemas/ReturnResolutionLineItem"},"type":"array"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"payment_intent_ids":{"items":{"type":"string"},"type":"array"},"payment_intents":{"items":{"$ref":"#/components/schemas/ExpandedPaymentIntentSummary"},"type":"array"},"pricing_basis":{"enum":["original_price","current_price","merchant_agreed_price"],"type":"string","x-enum-descriptions":["Original price.","Current price.","Merchant agreed price."],"x-flint-enum":"closed"},"refund_ids":{"items":{"type":"string"},"type":"array"},"refunds":{"items":{"$ref":"#/components/schemas/Refund"},"type":"array"},"replacement_line_items":{"items":{"$ref":"#/components/schemas/ReturnReplacementLineItem"},"type":"array"},"replacement_order":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrderSummary"},{"type":"null"}]},"replacement_order_id":{"type":"string"},"replacement_total_money":{"$ref":"#/components/schemas/Money"},"resolution_type":{"enum":["refund","exchange","replacement","no_monetary_action","correction"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action.","Correction."],"x-flint-enum":"closed"},"return_id":{"type":"string"},"return_policy_revision_id":{"type":"string"},"return_resolution_id":{"type":"string"},"returned_total_money":{"$ref":"#/components/schemas/Money"},"status":{"enum":["proposed","pending","requires_action","partially_fulfilled","fulfilled","failed","canceled"],"type":"string","x-enum-descriptions":["Proposed.","Pending.","Requires action.","Partially fulfilled.","Fulfilled.","Failed.","Canceled."],"x-flint-enum":"open"},"supported_actions":{"items":{"type":"string"},"type":"array"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"version":{"format":"int64","minimum":0,"type":"integer"}},"required":["adjustments","buyer_payment_amount_money","buyer_refund_amount_money","created_at","created_by","credit_money","deduction_money","execution_blockers","line_items","metadata","payment_intent_ids","refund_ids","replacement_line_items","replacement_total_money","resolution_type","return_id","return_resolution_id","returned_total_money","status","supported_actions","updated_at","version"],"type":"object"},"ReturnResolutionAdjustment":{"properties":{"adjustment_type":{"enum":["return_shipping_fee","restocking_fee","other_fee","goodwill_credit","price_correction","other"],"type":"string","x-enum-descriptions":["Return shipping fee.","Restocking fee.","Other fee.","Goodwill credit.","Price correction.","Other."],"x-flint-enum":"closed"},"applied_amount_money":{"$ref":"#/components/schemas/Money"},"assessed_amount_money":{"$ref":"#/components/schemas/Money"},"reason":{"enum":["return_policy","inspection_result","return_shipping_cost","customer_service","manual_correction","other"],"type":"string","x-enum-descriptions":["Return policy.","Inspection result.","Return shipping cost.","Customer service.","Manual correction.","Other."],"x-flint-enum":"closed"},"reason_message":{"type":"string"},"return_line_item_id":{"type":"string"},"return_policy_revision_id":{"type":"string"},"status":{"enum":["applied","waived"],"type":"string","x-enum-descriptions":["Applied.","Waived."],"x-flint-enum":"open"},"value_effect":{"enum":["deduction","credit"],"type":"string","x-enum-descriptions":["Deduction.","Credit."],"x-flint-enum":"closed"},"waived_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"waived_by":{"$ref":"#/components/schemas/ReturnActor"},"waiver_reason":{"enum":["policy_override","merchant_review","customer_service","other"],"type":"string","x-enum-descriptions":["Policy override.","Merchant review.","Customer service.","Other."],"x-flint-enum":"closed"},"waiver_reason_message":{"type":"string"}},"required":["adjustment_type","applied_amount_money","assessed_amount_money","reason","status","value_effect"],"type":"object"},"ReturnResolutionAdjustmentInput":{"additionalProperties":false,"properties":{"adjustment_type":{"enum":["return_shipping_fee","restocking_fee","other_fee","goodwill_credit","price_correction","other"],"type":"string","x-enum-descriptions":["Return shipping fee.","Restocking fee.","Other fee.","Goodwill credit.","Price correction.","Other."],"x-flint-enum":"closed"},"applied_amount_money":{"$ref":"#/components/schemas/Money"},"assessed_amount_money":{"$ref":"#/components/schemas/Money"},"reason":{"enum":["return_policy","inspection_result","return_shipping_cost","customer_service","manual_correction","other"],"type":"string","x-enum-descriptions":["Return policy.","Inspection result.","Return shipping cost.","Customer service.","Manual correction.","Other."],"x-flint-enum":"closed"},"reason_message":{"type":"string"},"return_line_item_id":{"type":"string"},"status":{"enum":["applied","waived"],"type":"string","x-enum-descriptions":["Applied.","Waived."],"x-flint-enum":"open"},"value_effect":{"enum":["deduction","credit"],"type":"string","x-enum-descriptions":["Deduction.","Credit."],"x-flint-enum":"closed"},"waiver_reason":{"enum":["policy_override","merchant_review","customer_service","other"],"type":"string","x-enum-descriptions":["Policy override.","Merchant review.","Customer service.","Other."],"x-flint-enum":"closed"},"waiver_reason_message":{"type":"string"}},"required":["adjustment_type","applied_amount_money","assessed_amount_money","reason","value_effect"],"type":"object"},"ReturnResolutionAdjustmentSet":{"additionalProperties":false,"properties":{"adjustments":{"items":{"$ref":"#/components/schemas/ReturnResolutionAdjustmentInput"},"type":"array"}},"type":"object"},"ReturnResolutionExecutionBlocker":{"properties":{"code":{"enum":["handoff_pending","receipt_pending","inspection_pending","manual_release_pending","buyer_payment_pending","refund_pending","replacement_order_pending","fulfillment_pending","credit_effect_pending"],"type":"string","x-enum-descriptions":["Handoff pending.","Receipt pending.","Inspection pending.","Manual release pending.","Buyer payment pending.","Refund pending.","Replacement order pending.","Fulfillment pending.","Credit effect pending."],"x-flint-enum":"closed"},"linked_resource_id":{"type":"string"},"linked_resource_type":{"enum":["refund","payment_intent","order","fulfillment","credit_transaction"],"type":"string","x-enum-descriptions":["Refund.","Payment intent.","Order.","Fulfillment.","Credit transaction."],"x-flint-enum":"closed"},"return_line_item_id":{"type":"string"}},"required":["code"],"type":"object"},"ReturnResolutionLineItem":{"properties":{"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"refund_timing":{"enum":["after_approval","after_handoff","after_receipt","after_inspection","manual"],"type":"string","x-enum-descriptions":["After approval.","After handoff.","After receipt.","After inspection.","Manual."],"x-flint-enum":"closed"},"return_line_item_id":{"type":"string"},"return_resolution_id":{"type":"string"},"return_resolution_line_item_id":{"type":"string"},"returned_total_money":{"$ref":"#/components/schemas/Money"}},"required":["quantity","return_line_item_id","return_resolution_id","return_resolution_line_item_id","returned_total_money"],"type":"object"},"ReturnResolutionLineItemInput":{"additionalProperties":false,"properties":{"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"return_line_item_id":{"type":"string"}},"required":["quantity","return_line_item_id"],"type":"object"},"ReturnResolutionLineItemReplacementInput":{"additionalProperties":false,"properties":{"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"return_line_item_id":{"type":"string"},"return_resolution_line_item_id":{"type":"string"}},"required":["quantity","return_line_item_id"],"type":"object"},"ReturnResolutionPreview":{"properties":{"adjustments":{"items":{"$ref":"#/components/schemas/ReturnResolutionAdjustment"},"type":"array"},"based_on_return_revision":{"format":"int64","minimum":0,"type":"integer"},"buyer_payment_amount_money":{"$ref":"#/components/schemas/Money"},"buyer_refund_amount_money":{"$ref":"#/components/schemas/Money"},"calculated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"corrects_return_resolution_id":{"type":"string"},"credit_money":{"$ref":"#/components/schemas/Money"},"deduction_money":{"$ref":"#/components/schemas/Money"},"line_items":{"items":{"$ref":"#/components/schemas/ReturnResolutionLineItem"},"type":"array"},"replacement_line_items":{"items":{"$ref":"#/components/schemas/ReturnReplacementLineItem"},"type":"array"},"replacement_total_money":{"$ref":"#/components/schemas/Money"},"resolution_type":{"enum":["refund","exchange","replacement","no_monetary_action","correction"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action.","Correction."],"x-flint-enum":"closed"},"return_id":{"type":"string"},"returned_total_money":{"$ref":"#/components/schemas/Money"},"warnings":{"items":{"$ref":"#/components/schemas/ReturnResolutionWarning"},"type":"array"}},"required":["adjustments","based_on_return_revision","buyer_payment_amount_money","buyer_refund_amount_money","calculated_at","credit_money","deduction_money","line_items","replacement_line_items","replacement_total_money","resolution_type","return_id","returned_total_money","warnings"],"type":"object"},"ReturnResolutionWarning":{"properties":{"code":{"type":"string"},"message":{"type":"string"},"return_line_item_ids":{"items":{"type":"string"},"type":"array"}},"required":["code","message","return_line_item_ids"],"type":"object"},"ReturnRestockingFeePolicy":{"additionalProperties":false,"properties":{"calculation_type":{"enum":["flat","percent"],"type":"string","x-enum-descriptions":["Flat.","Percent."],"x-flint-enum":"closed"},"flat_money":{"$ref":"#/components/schemas/Money"},"percent":{"format":"double","multipleOf":0.0001,"type":"number"}},"required":["calculation_type"],"type":"object"},"ReturnShipmentLineItemAllocation":{"properties":{"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"return_line_item_id":{"type":"string"}},"required":["quantity","return_line_item_id"],"type":"object"},"ReturnShippingPolicy":{"additionalProperties":false,"properties":{"payer":{"enum":["merchant","buyer"],"type":"string","x-enum-descriptions":["Merchant.","Buyer."],"x-flint-enum":"closed"}},"required":["payer"],"type":"object"},"ReturnSourceSystem":{"additionalProperties":false,"properties":{"external_source_id":{"type":"string"},"source_system_type":{"enum":["manual","pos","wms","erp","other","flint"],"type":"string","x-enum-descriptions":["Manual.","Pos.","Wms.","Erp.","Other.","Flint."],"x-flint-enum":"closed"}},"required":["source_system_type"],"type":"object"},"ReturnUnverifiedItem":{"additionalProperties":false,"properties":{"description":{"type":"string"},"name":{"type":"string"},"sku":{"type":"string"}},"required":["name"],"type":"object"},"ReturnWindow":{"additionalProperties":false,"properties":{"duration_seconds":{"format":"int64","type":"integer"},"starts_at_event":{"enum":["fulfilled","delivered","picked_up","service_completed"],"type":"string","x-enum-descriptions":["Fulfilled.","Delivered.","Picked up.","Service completed."],"x-flint-enum":"closed"}},"required":["duration_seconds","starts_at_event"],"type":"object"},"Review":{"properties":{"closed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]},"closed_by":{"type":["string","null"]},"closed_reason":{"enum":["approved","declined","refunded","refunded_as_fraud","disputed","payment_canceled","expired","other",null],"type":["string","null"],"x-enum-descriptions":["Approved.","Declined.","Refunded.","Refunded as fraud.","Disputed.","Payment canceled.","Expired.","Other.","Null."],"x-flint-enum":"closed"},"customer":{"anyOf":[{"$ref":"#/components/schemas/ExpandedCustomerSummary"},{"type":"null"}]},"customer_id":{"type":["string","null"]},"ip_address":{"type":["string","null"]},"ip_address_location":{"anyOf":[{"$ref":"#/components/schemas/PublicIPAddressLocation"},{"type":"null"}]},"matched_risk_rule_id":{"type":["string","null"]},"opened_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"opened_reason":{"enum":["rule","manual"],"type":"string","x-enum-descriptions":["Rule.","Manual."],"x-flint-enum":"closed"},"order":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrderSummary"},{"type":"null"}]},"order_id":{"type":["string","null"]},"payment_flow":{"enum":["checkout","payment_link","invoice","subscription_initial","subscription_renewal","virtual_terminal","api"],"type":"string","x-enum-descriptions":["Checkout.","Payment link.","Invoice.","Subscription initial.","Subscription renewal.","Virtual terminal.","Api."],"x-flint-enum":"closed"},"payment_intent":{"anyOf":[{"$ref":"#/components/schemas/ExpandedPaymentIntentSummary"},{"type":"null"}]},"payment_intent_id":{"type":"string"},"payment_summary":{"$ref":"#/components/schemas/PublicRiskPaymentSummary"},"pending_action":{"enum":["approve","decline",null],"type":["string","null"],"x-enum-descriptions":["Approve.","Decline.","Null."],"x-flint-enum":"closed"},"refund_id":{"type":["string","null"]},"refunded_amount_money":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"resolution_started_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]},"resolution_started_by":{"type":["string","null"]},"review_id":{"type":"string"},"risk":{"$ref":"#/components/schemas/PublicReviewRisk"},"status":{"enum":["open","resolving","closed"],"type":"string","x-enum-descriptions":["Open.","Resolving.","Closed."],"x-flint-enum":"open"}},"required":["review_id","status","pending_action","resolution_started_at","resolution_started_by","opened_reason","closed_reason","payment_intent_id","order_id","customer_id","payment_flow","risk","ip_address","ip_address_location","matched_risk_rule_id","payment_summary","refund_id","refunded_amount_money","opened_at","closed_at","closed_by"],"type":"object"},"ReviewListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Review"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ReviewResponse":{"properties":{"data":{"$ref":"#/components/schemas/Review"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"RevokeDeliveryDependencyRequest":{"properties":{"merchant_note":{"type":"string"},"reason":{"enum":["unsafe_configuration","location_unavailable","credential_compromise","legal_requirement","other"],"type":"string","x-enum-descriptions":["Unsafe configuration.","Location unavailable.","Credential compromise.","Legal requirement.","Other."],"x-flint-enum":"closed"},"target":{"$ref":"#/components/schemas/DeliveryRevocationTarget"}},"required":["reason","target"],"type":"object"},"RevokeOrganizationMembershipResponse":{"properties":{"data":{"$ref":"#/components/schemas/RevokeOrganizationMembershipResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"RevokeOrganizationMembershipResult":{"properties":{"organization_id":{"type":"string"},"user_id":{"type":"string"}},"required":["organization_id","user_id"],"type":"object"},"RiskList":{"properties":{"alias":{"type":"string"},"archived_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"created_by":{"type":"string"},"item_count":{"format":"int64","type":"integer"},"item_type":{"enum":["card_fingerprint","card_bin","email","email_domain","ip_address","country","customer_id","string","case_sensitive_string"],"type":"string","x-enum-descriptions":["Card fingerprint.","Card bin.","Email.","Email domain.","Ip address.","Country.","Customer id.","String.","Case sensitive string."],"x-flint-enum":"closed"},"name":{"type":"string"},"risk_list_id":{"type":"string"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["alias","created_at","created_by","item_count","item_type","name","risk_list_id","updated_at","archived_at"],"type":"object"},"RiskListItem":{"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"created_by":{"type":"string"},"risk_list_id":{"type":"string"},"risk_list_item_id":{"type":"string"},"value":{"type":"string"}},"required":["created_at","created_by","risk_list_id","risk_list_item_id","value"],"type":"object"},"RiskListItemListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RiskListItem"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"RiskListItemResponse":{"properties":{"data":{"$ref":"#/components/schemas/RiskListItem"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"RiskListItemResultsData":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PublicRiskListItemResult"},"type":"array"}},"required":["items"],"type":"object"},"RiskListItemResultsResponse":{"properties":{"data":{"$ref":"#/components/schemas/RiskListItemResultsData"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"RiskListListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RiskList"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"RiskListResourceResponse":{"properties":{"data":{"$ref":"#/components/schemas/RiskList"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"RiskPredicateNode":{"oneOf":[{"additionalProperties":false,"properties":{"all":{"items":{"$ref":"#/components/schemas/RiskPredicateNode"},"maxItems":50,"minItems":1,"type":"array"}},"required":["all"],"type":"object"},{"additionalProperties":false,"properties":{"any":{"items":{"$ref":"#/components/schemas/RiskPredicateNode"},"maxItems":50,"minItems":1,"type":"array"}},"required":["any"],"type":"object"},{"additionalProperties":false,"properties":{"not":{"$ref":"#/components/schemas/RiskPredicateNode"}},"required":["not"],"type":"object"},{"additionalProperties":false,"properties":{"attribute":{"maxLength":280,"minLength":1,"type":"string"},"operator":{"enum":["eq","neq","gt","gte","lt","lte"],"type":"string","x-enum-descriptions":["Eq.","Neq.","Gt.","Gte.","Lt.","Lte."],"x-flint-enum":"closed"},"value":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"boolean"}]}},"required":["attribute","operator","value"],"type":"object"},{"additionalProperties":false,"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"attribute":{"enum":["amount_money"],"type":"string","x-enum-descriptions":["Amount money."],"x-flint-enum":"closed"},"operator":{"enum":["eq","neq","gt","gte","lt","lte"],"type":"string","x-enum-descriptions":["Eq.","Neq.","Gt.","Gte.","Lt.","Lte."],"x-flint-enum":"closed"}},"required":["attribute","operator","amount_money"],"type":"object"},{"additionalProperties":false,"properties":{"attribute":{"maxLength":280,"minLength":1,"type":"string"},"operator":{"enum":["in"],"type":"string","x-enum-descriptions":["In."],"x-flint-enum":"closed"},"values":{"items":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"boolean"}]},"maxItems":100,"minItems":1,"type":"array"}},"required":["attribute","operator","values"],"type":"object"},{"additionalProperties":false,"properties":{"attribute":{"maxLength":280,"minLength":1,"type":"string"},"list_alias":{"pattern":"^[a-z][a-z0-9_]{0,127}$","type":"string"},"operator":{"enum":["in_list"],"type":"string","x-enum-descriptions":["In list."],"x-flint-enum":"closed"}},"required":["attribute","operator","list_alias"],"type":"object"},{"additionalProperties":false,"properties":{"attribute":{"maxLength":280,"minLength":1,"type":"string"},"operator":{"enum":["is_missing"],"type":"string","x-enum-descriptions":["Is missing."],"x-flint-enum":"closed"}},"required":["attribute","operator"],"type":"object"}]},"RiskRule":{"properties":{"action":{"enum":["allow","block","review","require_3ds"],"type":"string","x-enum-descriptions":["Allow.","Block.","Review.","Require 3ds."],"x-flint-enum":"closed"},"applicability":{"enum":["all_payments","on_session_only"],"type":"string","x-enum-descriptions":["All payments.","On session only."],"x-flint-enum":"closed"},"archived_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]},"attributes_used":{"items":{"type":"string"},"type":"array"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"created_by":{"type":"string"},"description":{"type":"string"},"editable":{"type":"boolean"},"enabled":{"type":"boolean"},"origin":{"enum":["system_default","merchant"],"type":"string","x-enum-descriptions":["System default.","Merchant."],"x-flint-enum":"closed"},"predicate":{"$ref":"#/components/schemas/RiskPredicateNode"},"risk_rule_id":{"type":"string"},"stage":{"enum":["pre_authorization","post_authorization"],"type":"string","x-enum-descriptions":["Pre authorization.","Post authorization."],"x-flint-enum":"closed"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"version":{"format":"int64","type":"integer"}},"required":["action","applicability","attributes_used","created_at","created_by","description","editable","enabled","origin","predicate","risk_rule_id","stage","updated_at","version","archived_at"],"type":"object"},"RiskRuleAttributeRegistryResponse":{"properties":{"data":{"$ref":"#/components/schemas/PublicRiskAttributeRegistry"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"RiskRuleListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RiskRule"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"RiskRuleResponse":{"properties":{"data":{"$ref":"#/components/schemas/RiskRule"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"RiskRuleValidationResponse":{"properties":{"data":{"$ref":"#/components/schemas/RuleValidation"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"RotatePartnerAppSecretResponse":{"properties":{"data":{"$ref":"#/components/schemas/PartnerAppSecretRotationResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"RuleValidation":{"properties":{"analysis":{"$ref":"#/components/schemas/Analysis"},"warnings":{"items":{"$ref":"#/components/schemas/RuleWarning"},"type":"array"}},"required":["analysis","warnings"],"type":"object"},"RuleWarning":{"properties":{"code":{"type":"string"},"context":{"additionalProperties":{"type":"string"},"type":"object"},"message":{"type":"string"},"severity":{"type":"string"}},"required":["code","context","message","severity"],"type":"object"},"SandboxListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DeveloperSandbox"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"SandboxResponse":{"properties":{"data":{"$ref":"#/components/schemas/DeveloperSandbox"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"SandboxWithAPIKeyResponse":{"properties":{"data":{"$ref":"#/components/schemas/DeveloperSandboxWithAPIKey"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"SaveMePaymentMethodRequest":{"properties":{"payment_method_type":{"enum":["card"],"type":"string","x-enum-descriptions":["Card."],"x-flint-enum":"closed"}},"type":"object"},"SavePaymentMethodRequest":{"properties":{"customer_id":{"type":"string"},"type":{"enum":["card"],"type":"string","x-enum-descriptions":["Card."],"x-flint-enum":"closed"}},"required":["customer_id"],"type":"object"},"SavePaymentMethodResponse":{"properties":{"data":{"$ref":"#/components/schemas/SavePaymentMethodResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"SavePaymentMethodResult":{"properties":{"client_setup":{"$ref":"#/components/schemas/StripeClientSetup"},"payment_method":{"$ref":"#/components/schemas/PaymentMethod"}},"required":["payment_method"],"type":"object"},"ScopeRequirement":{"properties":{"mode":{"description":"How the required scopes are evaluated. all requires every listed scope; any requires at least one listed scope.","enum":["all","any"],"example":"all","type":"string","x-enum-descriptions":["All.","Any."],"x-flint-enum":"closed"},"scopes":{"description":"Canonical public scope names evaluated for this authorization decision.","example":["developer.sandboxes.write","accounts.api_keys.write"],"items":{"type":"string"},"type":"array"}},"required":["mode","scopes"],"type":"object"},"SelectableOrderPaymentIntent":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"last_payment_error":{"$ref":"#/components/schemas/PaymentErrorSummary"},"payment_collection":{"$ref":"#/components/schemas/PaymentCollection"},"payment_intent_id":{"type":"string"},"status":{"enum":["requires_payment_method","requires_confirmation","requires_action","processing","requires_capture","canceled","succeeded","expired"],"type":"string","x-enum-descriptions":["Requires payment method.","Requires confirmation.","Requires action.","Processing.","Requires capture.","Canceled.","Succeeded.","Expired."],"x-flint-enum":"open"},"tip_money":{"$ref":"#/components/schemas/Money"}},"required":["amount_money","payment_intent_id","status","tip_money"],"type":"object"},"SelectedProductOption":{"properties":{"option_id":{"type":"string"},"option_name":{"type":"string"},"option_value_id":{"type":"string"},"value":{"type":"string"}},"required":["option_id","option_name","option_value_id","value"],"type":"object"},"ServiceFulfillmentDetails":{"properties":{"completed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"notes":{"type":"string"},"scheduled_end_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"scheduled_start_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"type":"object"},"SetDefaultCustomerAddressRequest":{"properties":{"default_for":{"enum":["billing","shipping","both"],"type":"string","x-enum-descriptions":["Billing.","Shipping.","Both."],"x-flint-enum":"closed"}},"required":["default_for"],"type":"object"},"Settings":{"properties":{"branding":{"$ref":"#/components/schemas/BrandingSettings"},"catalog":{"$ref":"#/components/schemas/CatalogSettings"},"checkout":{"$ref":"#/components/schemas/CheckoutSettings"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"customer_account":{"$ref":"#/components/schemas/CustomerAccountSettings"},"customer_account_domain_status":{"$ref":"#/components/schemas/CustomerAccountDomainStatus","readOnly":true},"customer_email_delivery":{"$ref":"#/components/schemas/CustomerEmailDeliverySettings"},"device_id":{"readOnly":true,"type":"string"},"fulfillment":{"$ref":"#/components/schemas/FulfillmentSettings"},"inventory":{"$ref":"#/components/schemas/InventorySettings"},"invoices":{"$ref":"#/components/schemas/InvoiceSettings"},"legal":{"$ref":"#/components/schemas/LegalSettings"},"location_id":{"readOnly":true,"type":"string"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"organization_id":{"readOnly":true,"type":"string"},"payment_limits":{"$ref":"#/components/schemas/PaymentLimitSettings","readOnly":true},"promotions":{"$ref":"#/components/schemas/PromotionSettings"},"receipts":{"$ref":"#/components/schemas/ReceiptSettings"},"settings_id":{"readOnly":true,"type":"string"},"settings_scope":{"enum":["organization","merchant","location","device"],"readOnly":true,"type":"string","x-enum-descriptions":["Organization.","Merchant.","Location.","Device."],"x-flint-enum":"closed"},"subscriptions":{"$ref":"#/components/schemas/SubscriptionSettings"},"tax":{"$ref":"#/components/schemas/TaxSettings"},"tax_identity":{"anyOf":[{"$ref":"#/components/schemas/TaxIdentity"},{"type":"null"}]},"tipping":{"$ref":"#/components/schemas/TippingSettings"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"version":{"format":"uint64","minimum":1,"readOnly":true,"type":"integer"}},"required":["settings_id","settings_scope","version"],"type":"object"},"SettingsResponse":{"properties":{"data":{"$ref":"#/components/schemas/Settings"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"SettlementAmounts":{"properties":{"balance_money":{"$ref":"#/components/schemas/SignedMoney"},"credit_money":{"$ref":"#/components/schemas/Money"},"net_collected_money":{"$ref":"#/components/schemas/Money"},"outstanding_money":{"$ref":"#/components/schemas/Money"},"paid_money":{"$ref":"#/components/schemas/Money"},"refunded_money":{"$ref":"#/components/schemas/Money"},"settled_tip_money":{"$ref":"#/components/schemas/Money"}},"required":["balance_money","credit_money","net_collected_money","outstanding_money","paid_money","refunded_money","settled_tip_money"],"type":"object"},"Shipment":{"properties":{"created_at":{"description":"Creation timestamp.","format":"date-time","readOnly":true,"type":"string"},"delivered_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"direction":{"enum":["outbound","return"],"readOnly":true,"type":"string","x-enum-descriptions":["Outbound.","Return."],"x-flint-enum":"closed"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system. Caller-owned shipment identifier in external_system. Set with external_system to enable duplicate detection and replay for that provider reference.","maxLength":255,"type":"string"},"external_system":{"description":"External carrier, aggregator, or fulfillment platform name for this shipment. Set with external_reference_id to enable duplicate detection and replay for that provider reference; without external_reference_id this is stored as provenance only.","type":"string"},"fulfillment_id":{"readOnly":true,"type":"string"},"handed_off_at":{"description":"Carrier acceptance timestamp. For return shipments, this can satisfy an after_handoff execution gate for the declared return_line_items.","format":"date-time","readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrderSummary"},{"type":"null"}],"readOnly":true},"order_id":{"readOnly":true,"type":"string"},"package_count":{"description":"Total number of packages attached to the shipment, including voided packages.","format":"int32","minimum":0,"readOnly":true,"type":"integer"},"return_id":{"type":"string"},"return_line_items":{"items":{"$ref":"#/components/schemas/ReturnShipmentLineItemAllocation"},"type":"array"},"shipment_id":{"readOnly":true,"type":"string"},"shipped_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"status":{"description":"Read-only shipment state derived from the shipment's package states. An empty shipment remains a created draft.\n- `created`: The shipment leg exists but has not been packed or handed off.\n- `packed`: The shipment leg is packed and awaiting carrier handoff.\n- `shipped`: The shipment leg was handed to the carrier.\n- `in_transit`: The carrier is moving the shipment through its network.\n- `out_for_delivery`: The shipment is on its final delivery route.\n- `delivered`: The carrier reported successful delivery.\n- `delivery_attempted`: The carrier attempted delivery but did not complete it. Follow the carrier instructions before retrying delivery.\n- `exception`: A carrier exception is blocking normal progress. Resolve the carrier-reported issue.\n- `returned`: The shipment was returned toward or to its origin.\n- `voided`: The shipment was voided and will not continue through delivery.","enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"readOnly":true,"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open","x-flint-enum-descriptions":{"created":"The shipment leg exists but has not been packed or handed off.","delivered":"The carrier reported successful delivery.","delivery_attempted":"The carrier attempted delivery but did not complete it. Follow the carrier instructions before retrying delivery.","exception":"A carrier exception is blocking normal progress. Resolve the carrier-reported issue.","in_transit":"The carrier is moving the shipment through its network.","out_for_delivery":"The shipment is on its final delivery route.","packed":"The shipment leg is packed and awaiting carrier handoff.","returned":"The shipment was returned toward or to its origin.","shipped":"The shipment leg was handed to the carrier.","voided":"The shipment was voided and will not continue through delivery."}},"updated_at":{"description":"Last update timestamp.","format":"date-time","readOnly":true,"type":"string"},"version":{"description":"Monotonic shipment version for expected_version checks.","format":"uint64","minimum":1,"readOnly":true,"type":"integer"}},"required":["direction","fulfillment_id","order_id","package_count","shipment_id","status","version"],"type":"object"},"ShipmentListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Shipment"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ShipmentResponse":{"properties":{"data":{"$ref":"#/components/schemas/Shipment"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"ShippingDimensions":{"properties":{"height":{"type":"number"},"length":{"type":"number"},"unit":{"type":"string"},"width":{"type":"number"}},"required":["height","length","unit","width"],"type":"object"},"ShippingWeight":{"properties":{"unit":{"description":"Weight unit. Use gram, kilogram, ounce, or pound.","enum":["gram","kilogram","ounce","pound"],"type":"string","x-enum-descriptions":["Gram.","Kilogram.","Ounce.","Pound."],"x-flint-enum":"closed"},"value":{"type":"number"}},"required":["unit","value"],"type":"object"},"SignedMoney":{"description":"Signed monetary amount represented as integer minor units plus an ISO 4217 currency code.","properties":{"amount":{"description":"Signed amount in the currency's minor unit, such as cents for USD.","format":"int64","type":"integer"},"currency":{"description":"ISO 4217 currency code for this amount.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"}},"required":["amount","currency"],"type":"object"},"SkipSubscriptionCycleRequest":{"additionalProperties":false,"properties":{"initiated_by":{"description":"Optional business actor. Omit when the actor is unknown.","enum":["buyer","merchant","integration"],"type":"string","x-enum-descriptions":["Buyer.","Merchant.","Integration."],"x-flint-enum":"closed"}},"type":"object"},"StripeClientAuthority":{"description":"One-time client authority for the named Stripe object. This payload always names the Stripe.js call and carries its client secret.","properties":{"client_secret":{"description":"Stripe client secret for the named PaymentIntent or SetupIntent.","type":"string"},"stripe_js_call":{"description":"Stripe.js operation to perform now. confirm_setup applies to client_setup. Standalone PaymentIntents use payment_collection plus server confirmation instead of initial confirm_payment authority.","enum":["confirm_payment","confirm_setup"],"type":"string","x-enum-descriptions":["Confirm payment.","Confirm setup."],"x-flint-enum":"closed"}},"required":["client_secret","stripe_js_call"],"type":"object"},"StripeClientSetup":{"description":"Stripe.js setup authority returned while saving a payment method. Follow its stripe_js_call now. setup_collection is guidance instead and never carries a secret.","properties":{"stripe":{"$ref":"#/components/schemas/StripeClientSetupStripe"}},"type":"object"},"StripeClientSetupStripe":{"description":"Stripe.js initialization context and SetupIntent setup authority.","properties":{"account_id":{"description":"Stripe connected account ID to pass as stripeAccount when initializing Stripe.js.","type":"string"},"publishable_key":{"description":"Stripe publishable key for the active Flint payment mode; use this with account_id when loading Stripe.js.","type":"string"},"setup_intent":{"$ref":"#/components/schemas/StripeClientAuthority"}},"type":"object"},"StripePaymentClientAction":{"description":"Stripe.js initialization context plus one flow-specific authority object. Exactly one of payment_intent or setup_intent is present.","properties":{"account_id":{"description":"Stripe connected account ID to pass as stripeAccount when initializing Stripe.js.","type":"string"},"payment_intent":{"$ref":"#/components/schemas/StripePaymentIntentClientAction","description":"PaymentIntent authority for an order payment authentication action."},"publishable_key":{"description":"Stripe publishable key for the active Flint payment mode; use this with account_id when loading Stripe.js.","type":"string"},"setup_intent":{"$ref":"#/components/schemas/StripeSetupIntentClientAction","description":"SetupIntent authority for a saved-payment-method authentication action."}},"required":["account_id","publishable_key"],"type":"object"},"StripePaymentIntentClientAction":{"properties":{"client_secret":{"description":"PaymentIntent client secret to pass to Stripe.js handleNextAction.","type":"string"},"stripe_js_call":{"description":"Stripe.js operation to perform. Today this is handle_next_action.","enum":["handle_next_action"],"type":"string","x-enum-descriptions":["Handle next action."],"x-flint-enum":"closed"}},"required":["client_secret","stripe_js_call"],"type":"object"},"StripeSetupIntentClientAction":{"properties":{"client_secret":{"description":"SetupIntent client secret to pass to Stripe.js handleNextAction.","type":"string"},"stripe_js_call":{"description":"Stripe.js operation to perform. Today this is handle_next_action.","enum":["handle_next_action"],"type":"string","x-enum-descriptions":["Handle next action."],"x-flint-enum":"closed"}},"required":["client_secret","stripe_js_call"],"type":"object"},"Subscription":{"properties":{"awaiting_billing_schedule":{"readOnly":true,"type":"boolean"},"billing_anchor_day":{"format":"int32","type":"integer"},"billing_interval":{"description":"How often the subscription bills, frozen when the subscription was created. Read with billing_interval_count: monthly with a count of 3 bills quarterly. Omitted for subscriptions created before Flint recorded this interval.","enum":["daily","weekly","monthly","yearly"],"readOnly":true,"type":"string","x-enum-descriptions":["Daily.","Weekly.","Monthly.","Yearly."],"x-flint-enum":"closed"},"billing_interval_count":{"description":"Number of billing_interval units between charges, frozen when the subscription was created. Omitted for subscriptions created before Flint recorded this interval.","format":"int32","readOnly":true,"type":"integer"},"billing_schedule_owner":{"enum":["flint","external"],"readOnly":true,"type":"string","x-enum-descriptions":["Flint.","External."],"x-flint-enum":"closed"},"billing_schedule_waiting_started_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"cancel_at_period_end":{"type":"boolean"},"canceled_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"contract_end_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"contract_start_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"current_period_end":{"readOnly":true,"type":"string"},"current_period_start":{"readOnly":true,"type":"string"},"customer":{"anyOf":[{"$ref":"#/components/schemas/ExpandedCustomerSummary"},{"type":"null"}],"readOnly":true},"customer_id":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"line_items":{"items":{"$ref":"#/components/schemas/SubscriptionLineItem"},"readOnly":true,"type":"array"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"next_billing_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"next_retry_at":{"description":"Recorded automatic payment retry time. Null when no retry time is available.","format":"date-time","readOnly":true,"type":["string","null"]},"paused_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"payment_method":{"anyOf":[{"$ref":"#/components/schemas/ExpandedPaymentMethodSummary"},{"type":"null"}],"readOnly":true},"payment_method_id":{"type":"string"},"plan_id":{"type":"string"},"recurring_amount_money":{"$ref":"#/components/schemas/Money","description":"What one billing period charges before tax and discounts, frozen when the subscription was created. Plan price changes after that do not change it. Omitted for subscriptions created before Flint recorded this amount.","readOnly":true},"service_location":{"$ref":"#/components/schemas/SubscriptionServiceLocation"},"starts_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"status":{"enum":["trialing","active","paused","past_due","canceled","incomplete"],"readOnly":true,"type":"string","x-enum-descriptions":["Trialing.","Active.","Paused.","Past due.","Canceled.","Incomplete."],"x-flint-enum":"open"},"subscription_id":{"readOnly":true,"type":"string"},"subscription_plan":{"anyOf":[{"$ref":"#/components/schemas/ExpandedSubscriptionPlanSummary"},{"type":"null"}],"readOnly":true},"trial_end":{"readOnly":true,"type":"string"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"}},"required":["billing_schedule_owner","cancel_at_period_end","customer_id","payment_method_id","plan_id","status","subscription_id"],"type":"object"},"SubscriptionAnalytics":{"properties":{"range":{"enum":["today","last_7_days","last_30_days"],"type":"string","x-enum-descriptions":["Today.","Last 7 days.","Last 30 days."],"x-flint-enum":"closed"},"snapshot_metrics":{"$ref":"#/components/schemas/SubscriptionSnapshotMetrics"},"timezone":{"type":"string"},"window_metrics":{"$ref":"#/components/schemas/SubscriptionWindowMetrics"}},"required":["range","snapshot_metrics","timezone","window_metrics"],"type":"object"},"SubscriptionAnalyticsResponse":{"properties":{"data":{"$ref":"#/components/schemas/SubscriptionAnalytics"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"SubscriptionBillingScheduleInput":{"additionalProperties":false,"properties":{"owner":{"enum":["flint","external"],"type":"string","x-enum-descriptions":["Flint.","External."],"x-flint-enum":"closed"}},"required":["owner"],"type":"object"},"SubscriptionBillingStartInput":{"description":"How billing begins. Send exactly one closed tagged-union branch.","discriminator":{"propertyName":"type"},"oneOf":[{"additionalProperties":false,"properties":{"type":{"enum":["immediate"],"type":"string","x-enum-descriptions":["Immediate."],"x-flint-enum":"closed"}},"required":["type"],"type":"object"},{"additionalProperties":false,"properties":{"starts_at":{"description":"Future instant when the first billing period starts.","format":"date-time","type":"string"},"type":{"enum":["scheduled"],"type":"string","x-enum-descriptions":["Scheduled."],"x-flint-enum":"closed"}},"required":["type","starts_at"],"type":"object"},{"additionalProperties":false,"properties":{"period_started_at":{"description":"Start of the already-running billing period being imported.","format":"date-time","type":"string"},"type":{"enum":["imported"],"type":"string","x-enum-descriptions":["Imported."],"x-flint-enum":"closed"}},"required":["type","period_started_at"],"type":"object"}]},"SubscriptionLineItem":{"properties":{"base_subtotal_money":{"$ref":"#/components/schemas/Money"},"bundle_components":{"items":{"$ref":"#/components/schemas/BundleComponent"},"type":"array"},"bundle_id":{"type":"string"},"categories":{"items":{"$ref":"#/components/schemas/CategoryReference"},"type":"array"},"description":{"type":"string"},"image":{"$ref":"#/components/schemas/Image"},"modifier_total_money":{"$ref":"#/components/schemas/Money"},"modifiers":{"items":{"$ref":"#/components/schemas/OrderLineItemModifier"},"type":"array"},"name":{"type":"string"},"product_id":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","type":"integer"},"selected_options":{"items":{"$ref":"#/components/schemas/SelectedProductOption"},"type":"array"},"sku":{"type":"string"},"source_type":{"enum":["variant","bundle"],"type":"string","x-enum-descriptions":["Variant.","Bundle."],"x-flint-enum":"closed"},"subscription_line_item_id":{"type":"string"},"subtotal_money":{"$ref":"#/components/schemas/Money"},"unit_price_money":{"$ref":"#/components/schemas/Money"},"variant_id":{"type":"string"}},"required":["base_subtotal_money","modifier_total_money","name","quantity","subtotal_money","unit_price_money"],"type":"object"},"SubscriptionListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Subscription"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"SubscriptionPaymentRetry":{"properties":{"completed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"failure":{"$ref":"#/components/schemas/SubscriptionPaymentRetryFailure"},"idempotency_key":{"type":"string"},"order_id":{"type":"string"},"payment_attempt_id":{"type":"string"},"started_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"status":{"enum":["pending","processing","succeeded","failed"],"type":"string","x-enum-descriptions":["Pending.","Processing.","Succeeded.","Failed."],"x-flint-enum":"open"},"subscription_id":{"type":"string"},"subscription_payment_retry_id":{"type":"string"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["created_at","idempotency_key","status","subscription_id","subscription_payment_retry_id","updated_at"],"type":"object"},"SubscriptionPaymentRetryFailure":{"additionalProperties":false,"properties":{"code":{"enum":["card_declined","insufficient_funds","bank_account_closed","bank_account_not_found","bank_debit_not_authorized","bank_account_restricted","bank_debit_limit_exceeded","authentication_required","payment_blocked","expired_card","incorrect_cvc","processing_error","payment_method_unavailable","payment_method_declined","payment_not_completed","payment_action_expired","payment_method_temporarily_unavailable","payment_failed"],"type":"string","x-enum-descriptions":["Card declined.","Insufficient funds.","Bank account closed.","Bank account not found.","Bank debit not authorized.","Bank account restricted.","Bank debit limit exceeded.","Authentication required.","Payment blocked.","Expired card.","Incorrect cvc.","Processing error.","Payment method unavailable.","Payment method declined.","Payment not completed.","Payment action expired.","Payment method temporarily unavailable.","Payment failed."],"x-flint-enum":"closed"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"SubscriptionPaymentRetryListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SubscriptionPaymentRetry"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"SubscriptionPaymentRetryResponse":{"properties":{"data":{"$ref":"#/components/schemas/SubscriptionPaymentRetry"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"SubscriptionPlan":{"properties":{"billing_interval":{"enum":["daily","weekly","monthly","yearly"],"type":"string","x-enum-descriptions":["Daily.","Weekly.","Monthly.","Yearly."],"x-flint-enum":"closed"},"billing_interval_count":{"format":"int32","type":"integer"},"contract_term_months":{"format":"int32","type":"integer"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"currency":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"},"description":{"type":"string"},"early_termination_fee_money":{"$ref":"#/components/schemas/Money"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"images":{"items":{"$ref":"#/components/schemas/Image"},"type":"array"},"line_items":{"items":{"$ref":"#/components/schemas/SubscriptionPlanLineItem"},"type":"array"},"merchant_id":{"readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"plan_id":{"readOnly":true,"type":"string"},"setup_fee_money":{"$ref":"#/components/schemas/Money"},"status":{"enum":["active","archived"],"readOnly":true,"type":"string","x-enum-descriptions":["Active.","Archived."],"x-flint-enum":"open"},"trial_period_days":{"format":"int32","type":"integer"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"version":{"format":"uint64","minimum":0,"readOnly":true,"type":"integer"}},"required":["billing_interval","billing_interval_count","currency","images","name","plan_id","status","version"],"type":"object"},"SubscriptionPlanLineItem":{"oneOf":[{"not":{"anyOf":[{"required":["bundle_id"]}]},"required":["variant_id"]},{"not":{"anyOf":[{"required":["variant_id"]}]},"required":["bundle_id"]},{"not":{"anyOf":[{"required":["variant_id"]},{"required":["bundle_id"]}]},"required":["name","unit_price_money"]}],"properties":{"bundle_components":{"items":{"$ref":"#/components/schemas/BundleComponent"},"readOnly":true,"type":"array"},"bundle_id":{"type":"string"},"categories":{"items":{"$ref":"#/components/schemas/CategoryReference"},"readOnly":true,"type":"array"},"description":{"type":"string"},"image":{"$ref":"#/components/schemas/Image","readOnly":true},"modifiers":{"items":{"$ref":"#/components/schemas/OrderLineItemModifier"},"type":"array"},"name":{"type":"string"},"product_id":{"readOnly":true,"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","type":"integer"},"selected_options":{"items":{"$ref":"#/components/schemas/SelectedProductOption"},"readOnly":true,"type":"array"},"sku":{"readOnly":true,"type":"string"},"subscription_plan_line_item_id":{"readOnly":true,"type":"string"},"tax":{"$ref":"#/components/schemas/OrderLineItemTax"},"unit_price_money":{"$ref":"#/components/schemas/Money"},"variant_id":{"type":"string"}},"required":["quantity","subscription_plan_line_item_id"],"type":"object"},"SubscriptionPlanLineItemInput":{"oneOf":[{"not":{"anyOf":[{"required":["bundle_id"]},{"required":["name"]},{"required":["unit_price_money"]},{"required":["description"]},{"required":["tax"]}]},"required":["variant_id"]},{"not":{"anyOf":[{"required":["variant_id"]},{"required":["name"]},{"required":["unit_price_money"]},{"required":["description"]},{"required":["tax"]}]},"required":["bundle_id"]},{"not":{"anyOf":[{"required":["variant_id"]},{"required":["bundle_id"]}]},"required":["name","unit_price_money"]}],"properties":{"bundle_id":{"type":"string"},"description":{"type":"string"},"modifiers":{"items":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemModifierInput"},{"not":{"required":["order_line_item_modifier_id"]}}]},"type":"array"},"name":{"type":"string"},"quantity":{"default":1,"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","type":"integer"},"tax":{"$ref":"#/components/schemas/OrderLineItemTax"},"unit_price_money":{"$ref":"#/components/schemas/Money"},"variant_id":{"type":"string"}},"type":"object"},"SubscriptionPlanListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SubscriptionPlan"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"SubscriptionPlanResponse":{"properties":{"data":{"$ref":"#/components/schemas/SubscriptionPlan"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"SubscriptionResponse":{"properties":{"data":{"$ref":"#/components/schemas/Subscription"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"SubscriptionServiceLocation":{"properties":{"address":{"$ref":"#/components/schemas/Address"},"customer_address_id":{"type":"string"}},"type":"object"},"SubscriptionServiceLocationInput":{"discriminator":{"propertyName":"source"},"oneOf":[{"additionalProperties":false,"properties":{"customer_address_id":{"type":"string"},"source":{"enum":["customer_address"],"type":"string","x-enum-descriptions":["Customer address."],"x-flint-enum":"closed"}},"required":["source","customer_address_id"],"type":"object"},{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/Address"},"source":{"enum":["address"],"type":"string","x-enum-descriptions":["Address."],"x-flint-enum":"closed"}},"required":["source","address"],"type":"object"}]},"SubscriptionSettings":{"properties":{"default_billing_schedule_owner":{"enum":["flint","external"],"type":"string","x-enum-descriptions":["Flint.","External."],"x-flint-enum":"closed"},"dunning_end_action":{"enum":["cancel","pause","notify_only"],"type":"string","x-enum-descriptions":["Cancel.","Pause.","Notify only."],"x-flint-enum":"closed"},"dunning_retry_days":{"format":"int32","type":"integer"},"external_dunning_end_action":{"enum":["cancel","pause","notify_only"],"type":"string","x-enum-descriptions":["Cancel.","Pause.","Notify only."],"x-flint-enum":"closed"}},"type":"object"},"SubscriptionSnapshotMetrics":{"properties":{"arr_by_currency":{"items":{"$ref":"#/components/schemas/Money"},"type":"array"},"mrr_by_currency":{"items":{"$ref":"#/components/schemas/Money"},"type":"array"},"status_counts":{"$ref":"#/components/schemas/SubscriptionStatusCounts"}},"required":["status_counts"],"type":"object"},"SubscriptionStatusCounts":{"properties":{"active_count":{"format":"int64","type":"integer"},"canceled_count":{"format":"int64","type":"integer"},"incomplete_count":{"format":"int64","type":"integer"},"past_due_count":{"format":"int64","type":"integer"},"paused_count":{"format":"int64","type":"integer"},"trialing_count":{"format":"int64","type":"integer"}},"required":["active_count","canceled_count","incomplete_count","past_due_count","paused_count","trialing_count"],"type":"object"},"SubscriptionWindowMetrics":{"properties":{"canceled_subscriptions":{"format":"int64","type":"integer"},"new_subscriptions":{"format":"int64","type":"integer"},"subscription_collected_money_by_currency":{"items":{"$ref":"#/components/schemas/Money"},"type":"array"}},"required":["canceled_subscriptions","new_subscriptions"],"type":"object"},"TaxBreakdown":{"oneOf":[{"not":{"required":["flat_money"]},"properties":{"calculation_type":{"enum":["percentage"],"type":"string","x-enum-descriptions":["Percentage."],"x-flint-enum":"closed"}},"required":["percentage"]},{"not":{"required":["percentage"]},"properties":{"calculation_type":{"enum":["flat_amount"],"type":"string","x-enum-descriptions":["Flat amount."],"x-flint-enum":"closed"}},"required":["flat_money"]}],"properties":{"calculation_type":{"enum":["percentage","flat_amount"],"readOnly":true,"type":"string","x-enum-descriptions":["Percentage.","Flat amount."],"x-flint-enum":"closed"},"flat_money":{"$ref":"#/components/schemas/Money","readOnly":true},"fulfillment_choice_group_id":{"readOnly":true,"type":"string"},"jurisdiction":{"$ref":"#/components/schemas/TaxJurisdiction","readOnly":true},"location_id":{"readOnly":true,"type":"string"},"order_charge_id":{"readOnly":true,"type":"string"},"order_line_item_id":{"readOnly":true,"type":"string"},"percentage":{"maximum":100,"minimum":0,"multipleOf":0.0001,"readOnly":true,"type":"number"},"price_mode":{"enum":["additive","inclusive"],"readOnly":true,"type":"string","x-enum-descriptions":["Additive.","Inclusive."],"x-flint-enum":"closed"},"tax_breakdown_id":{"readOnly":true,"type":"string"},"tax_money":{"$ref":"#/components/schemas/Money","readOnly":true},"tax_type":{"enum":["sales_tax","use_tax","retail_delivery_fee"],"readOnly":true,"type":"string","x-enum-descriptions":["Sales tax.","Use tax.","Retail delivery fee."],"x-flint-enum":"closed"},"taxability_reason":{"enum":["standard_rated","not_taxable","customer_exempt","tax_disabled","no_jurisdiction","location_required"],"readOnly":true,"type":"string","x-enum-descriptions":["Standard rated.","Not taxable.","Customer exempt.","Tax disabled.","No jurisdiction.","Location required."],"x-flint-enum":"closed"},"taxable_money":{"$ref":"#/components/schemas/Money","readOnly":true}},"required":["calculation_type","jurisdiction","price_mode","tax_breakdown_id","tax_money","tax_type","taxability_reason","taxable_money"],"type":"object"},"TaxCalculationInput":{"oneOf":[{"not":{"required":["components"]},"properties":{"mode":{"enum":["automatic"],"type":"string","x-enum-descriptions":["Automatic."],"x-flint-enum":"closed"}}},{"properties":{"mode":{"enum":["external"],"type":"string","x-enum-descriptions":["External."],"x-flint-enum":"closed"}},"required":["components"]}],"properties":{"components":{"items":{"$ref":"#/components/schemas/TaxComponentInput"},"minItems":1,"type":"array"},"mode":{"enum":["automatic","external"],"type":"string","x-enum-descriptions":["Automatic.","External."],"x-flint-enum":"closed"},"price_mode":{"enum":["additive","inclusive"],"type":"string","x-enum-descriptions":["Additive.","Inclusive."],"x-flint-enum":"closed"}},"required":["mode","price_mode"],"type":"object"},"TaxComponentInput":{"not":{"required":["flat_money"]},"properties":{"calculation_type":{"default":"percentage","enum":["percentage"],"type":"string","x-enum-descriptions":["Percentage."],"x-flint-enum":"closed"},"flat_money":{"$ref":"#/components/schemas/Money"},"jurisdiction":{"$ref":"#/components/schemas/TaxJurisdiction"},"percentage":{"maximum":100,"minimum":0,"multipleOf":0.0001,"type":"number"},"tax_type":{"enum":["sales_tax","use_tax"],"type":"string","x-enum-descriptions":["Sales tax.","Use tax."],"x-flint-enum":"closed"}},"required":["jurisdiction","percentage","tax_type"],"type":"object"},"TaxIdentity":{"description":"Merchant-provided legal identity displayed on invoices and credit notes. Does not verify IDs or change tax treatment. Tax IDs are an owned collection in display order; replacing the array requires the parent's expected_version. Existing entries retain their document_tax_id; omit an entry to remove it, or omit its ID to add one.","properties":{"legal_name":{"maxLength":255,"minLength":1,"type":["string","null"]},"registered_address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"tax_ids":{"items":{"$ref":"#/components/schemas/DocumentTaxID"},"maxItems":20,"type":"array"}},"required":["tax_ids"],"type":"object"},"TaxIdentityInput":{"description":"Merchant-provided legal identity displayed on invoices and credit notes. Does not verify IDs or change tax treatment. Tax IDs are an owned collection in display order; replacing the array requires the parent's expected_version. Existing entries retain their document_tax_id; omit an entry to remove it, or omit its ID to add one.","properties":{"legal_name":{"maxLength":255,"minLength":1,"type":["string","null"]},"registered_address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"tax_ids":{"items":{"$ref":"#/components/schemas/DocumentTaxID"},"maxItems":20,"type":"array"}},"type":"object"},"TaxIdentityPatch":{"description":"Merchant-provided legal identity displayed on invoices and credit notes. Does not verify IDs or change tax treatment. Tax IDs are an owned collection in display order; replacing the array requires the parent's expected_version. Existing entries retain their document_tax_id; omit an entry to remove it, or omit its ID to add one.","properties":{"legal_name":{"maxLength":255,"minLength":1,"type":["string","null"]},"registered_address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"tax_ids":{"items":{"$ref":"#/components/schemas/DocumentTaxID"},"maxItems":20,"type":"array"}},"type":"object"},"TaxJurisdiction":{"properties":{"code":{"description":"Stable opaque Flint jurisdiction key used for equality and report grouping.","type":"string"},"country":{"description":"ISO 3166-1 alpha-2 country code.","example":"US","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","type":"string"},"level":{"enum":["state","county","city","district"],"type":"string","x-enum-descriptions":["State.","County.","City.","District."],"x-flint-enum":"closed"},"name":{"type":"string"},"state":{"type":"string"}},"required":["code","country","level","name","state"],"type":"object"},"TaxSettings":{"properties":{"default_delivery_tax_category":{"description":"Charge category inherited by delivery methods that omit charge_tax_category. Null derives the category from the method type.","enum":["service_fee","shipping","delivery","handling","surcharge",null],"type":["string","null"],"x-enum-descriptions":["Service fee.","Shipping.","Delivery.","Handling.","Surcharge.","Null."],"x-flint-enum":"closed"},"default_delivery_taxable":{"description":"Taxability inherited by delivery methods that omit taxable. Defaults to true because Flint cannot yet derive delivery-charge taxability from category and jurisdiction alone.","type":"boolean"},"default_enabled":{"description":"Whether new checkouts and orders calculate tax by default. This does not decide whether an individual line item or delivery charge is taxable.","type":"boolean"},"default_line_item_tax_category":{"description":"Flint line-item tax category.","enum":["general","physical_goods","digital_goods","software","saas","services","professional_services","food","prepared_food","clothing","medical_goods","admission"],"type":"string","x-enum-descriptions":["General.","Physical goods.","Digital goods.","Software.","Saas.","Services.","Professional services.","Food.","Prepared food.","Clothing.","Medical goods.","Admission."],"x-flint-enum":"closed"}},"type":"object"},"TextModifierConfig":{"properties":{"max_length":{"format":"int32","type":"integer"},"min_length":{"format":"int32","type":"integer"},"multiline":{"type":"boolean"},"required":{"type":"boolean"}},"required":["multiline","required"],"type":"object"},"TextModifierConfigInput":{"properties":{"max_length":{"format":"int32","type":"integer"},"min_length":{"format":"int32","type":"integer"},"multiline":{"default":false,"type":"boolean"},"required":{"default":false,"type":"boolean"}},"type":"object"},"TextModifierInput":{"additionalProperties":false,"properties":{"modifier_group_id":{"type":"string"},"value":{"type":"string"}},"required":["modifier_group_id","value"],"type":"object"},"ThemeConfig":{"properties":{"accent_color":{"type":"string"},"primary_color":{"type":"string"},"title":{"type":"string"}},"type":"object"},"Tip":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"description":{"type":"string"},"effective_amount_money":{"$ref":"#/components/schemas/Money"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"name":{"type":"string"},"order_tip_id":{"type":"string"},"payment_intent_allocations":{"items":{"$ref":"#/components/schemas/TipPaymentIntentAllocation"},"type":"array"},"percent":{"multipleOf":0.0001,"type":"number"},"refunded_money":{"$ref":"#/components/schemas/Money"},"settled_amount_money":{"$ref":"#/components/schemas/Money"},"status":{"enum":["requested","settled","partially_refunded","refunded","canceled"],"type":"string","x-enum-descriptions":["Requested.","Settled.","Partially refunded.","Refunded.","Canceled."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["effective_amount_money","order_tip_id","refunded_money","settled_amount_money","status"],"type":"object"},"TipPaymentIntentAllocation":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"payment_intent_id":{"type":"string"}},"required":["amount_money","payment_intent_id"],"type":"object"},"TippingSettings":{"properties":{"default_enabled":{"type":"boolean"},"default_smart_tip_money":{"$ref":"#/components/schemas/Money"},"default_tip_percentage":{"type":"number"},"is_custom_tip_enabled":{"type":"boolean"},"is_smart_tips_enabled":{"type":"boolean"},"smart_tip_money_options":{"items":{"$ref":"#/components/schemas/Money"},"type":"array"},"tip_percentages":{"items":{"type":"number"},"type":"array"}},"type":"object"},"TransferOrganizationOwnershipRequest":{"properties":{"new_owner_user_id":{"type":"string"}},"required":["new_owner_user_id"],"type":"object"},"TransferOrganizationOwnershipResponse":{"properties":{"data":{"$ref":"#/components/schemas/TransferOrganizationOwnershipResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"TransferOrganizationOwnershipResult":{"properties":{"membership":{"$ref":"#/components/schemas/OrganizationMembership"},"previous_owner_user_id":{"type":"string"}},"required":["membership"],"type":"object"},"UpdateAPIKeyRequest":{"properties":{"expires_at":{"description":"Future RFC3339 timestamp. Send null to clear an existing API-key expiration.","format":"date-time","type":["string","null"]},"name":{"type":"string"},"scopes":{"items":{"enum":["accounts.api_keys.read","accounts.api_keys.write","accounts.devices.read","accounts.devices.write","accounts.organizations.read","accounts.organizations.write","analytics.read","capabilities.read","checkouts.checkout_sessions.read","checkouts.checkout_sessions.write","checkouts.payment_links.read","checkouts.payment_links.write","commerce.bundles.read","commerce.bundles.write","commerce.catalog.read","commerce.catalog.write","commerce.credit_notes.read","commerce.credit_notes.write","commerce.delivery.read","commerce.delivery.write","commerce.inventory.read","commerce.inventory.write","commerce.inventory_locations.write","commerce.inventory_policies.write","commerce.inventory_reservations.write","commerce.invoices.read","commerce.invoices.write","commerce.orders.read","commerce.orders.write","commerce.products.read","commerce.products.write","commerce.promotions.read","commerce.promotions.write","commerce.refunds.read","commerce.refunds.tax_overrides.write","commerce.refunds.write","commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write","commerce.subscription_plans.read","commerce.subscription_plans.write","commerce.subscriptions.read","commerce.subscriptions.write","customers.read","customers.sessions.write","customers.write","developer.feedback_reports.read","developer.feedback_reports.write","developer.partner_apps.read","developer.partner_apps.write","developer.request_logs.self.detail.read","developer.request_logs.self.read","developer.resource_timelines.read","developer.sandboxes.read","developer.sandboxes.write","merchant_billing.read","merchants.account_sessions.write","merchants.locations.read","merchants.locations.write","merchants.onboarding.read","merchants.onboarding.write","merchants.profile.read","merchants.profile.write","money_movement.balance_transactions.read","money_movement.balances.read","money_movement.payout_settings.read","money_movement.payout_settings.write","money_movement.payouts.read","money_movement.payouts.write","payments.disputes.read","payments.payment_intents.read","payments.payment_intents.write","payments.payment_method_domains.read","payments.payment_method_domains.write","payments.payment_methods.read","payments.payment_methods.write","payments.payment_options.read","reports.read","reports.write","risk.controls.write","risk.read","risk.reviews.write","settings.read","settings.write","webhooks.read","webhooks.write"],"type":"string","x-enum-descriptions":["Accounts.api keys.read.","Accounts.api keys.write.","Accounts.devices.read.","Accounts.devices.write.","Accounts.organizations.read.","Accounts.organizations.write.","Analytics.read.","Capabilities.read.","Checkouts.checkout sessions.read.","Checkouts.checkout sessions.write.","Checkouts.payment links.read.","Checkouts.payment links.write.","Commerce.bundles.read.","Commerce.bundles.write.","Commerce.catalog.read.","Commerce.catalog.write.","Commerce.credit notes.read.","Commerce.credit notes.write.","Commerce.delivery.read.","Commerce.delivery.write.","Commerce.inventory.read.","Commerce.inventory.write.","Commerce.inventory locations.write.","Commerce.inventory policies.write.","Commerce.inventory reservations.write.","Commerce.invoices.read.","Commerce.invoices.write.","Commerce.orders.read.","Commerce.orders.write.","Commerce.products.read.","Commerce.products.write.","Commerce.promotions.read.","Commerce.promotions.write.","Commerce.refunds.read.","Commerce.refunds.tax overrides.write.","Commerce.refunds.write.","Commerce.return policies.write.","Commerce.return reasons.write.","Commerce.returns.decisions.write.","Commerce.returns.operations.write.","Commerce.returns.process.write.","Commerce.returns.read.","Commerce.returns.resolutions.write.","Commerce.returns.write.","Commerce.subscription plans.read.","Commerce.subscription plans.write.","Commerce.subscriptions.read.","Commerce.subscriptions.write.","Customers.read.","Customers.sessions.write.","Customers.write.","Developer.feedback reports.read.","Developer.feedback reports.write.","Developer.partner apps.read.","Developer.partner apps.write.","Developer.request logs.self.detail.read.","Developer.request logs.self.read.","Developer.resource timelines.read.","Developer.sandboxes.read.","Developer.sandboxes.write.","Merchant billing.read.","Merchants.account sessions.write.","Merchants.locations.read.","Merchants.locations.write.","Merchants.onboarding.read.","Merchants.onboarding.write.","Merchants.profile.read.","Merchants.profile.write.","Money movement.balance transactions.read.","Money movement.balances.read.","Money movement.payout settings.read.","Money movement.payout settings.write.","Money movement.payouts.read.","Money movement.payouts.write.","Payments.disputes.read.","Payments.payment intents.read.","Payments.payment intents.write.","Payments.payment method domains.read.","Payments.payment method domains.write.","Payments.payment methods.read.","Payments.payment methods.write.","Payments.payment options.read.","Reports.read.","Reports.write.","Risk.controls.write.","Risk.read.","Risk.reviews.write.","Settings.read.","Settings.write.","Webhooks.read.","Webhooks.write."],"x-flint-enum":"closed"},"type":"array"}},"type":"object"},"UpdateBundleComponentInput":{"properties":{"bundle_component_id":{"pattern":"^bunc_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"delivery_profile_id":{"type":"string"},"position":{"format":"int32","minimum":0,"type":"integer"},"quantity":{"default":1,"description":"Whole-number quantity; fractional quantities are not supported.","format":"int32","maximum":9999,"minimum":1,"type":"integer"},"variant_id":{"pattern":"^var_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"}},"required":["variant_id"],"type":"object"},"UpdateBundleRequest":{"allOf":[{"anyOf":[{"not":{"required":["categories"]}},{"required":["expected_version"]}]},{"anyOf":[{"not":{"required":["components"]}},{"required":["expected_version"]}]},{"anyOf":[{"not":{"required":["images"]}},{"required":["expected_version"]}]}],"properties":{"barcode":{"type":"string"},"categories":{"items":{"maxLength":100,"minLength":1,"type":"string"},"maxItems":100,"type":"array"},"components":{"description":"Replaces all bundle components atomically. Include an existing bundle_component_id to retain a member. Omitted members are removed. Null is not accepted.","items":{"$ref":"#/components/schemas/UpdateBundleComponentInput"},"type":"array"},"description":{"type":"string"},"expected_version":{"description":"Resource version last read by the caller. Required when replacing an owned collection.","format":"uint64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"images":{"description":"The complete desired gallery in display order. The first image is primary. Send [] to clear the gallery.","items":{"$ref":"#/components/schemas/ImageInput"},"maxItems":8,"minItems":0,"type":"array"},"line_item_tax_category":{"description":"Flint line-item tax category.","enum":["general","physical_goods","digital_goods","software","saas","services","professional_services","food","prepared_food","clothing","medical_goods","admission"],"type":"string","x-enum-descriptions":["General.","Physical goods.","Digital goods.","Software.","Saas.","Services.","Professional services.","Food.","Prepared food.","Clothing.","Medical goods.","Admission."],"x-flint-enum":"closed"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"modifier_set_id":{"description":"Attached modifier set. Send null on update to remove it.","pattern":"^ms_[0-9A-HJKMNP-TV-Z]{26}$","type":["string","null"]},"name":{"type":"string"},"sku":{"type":"string"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"taxable":{"type":"boolean"},"unit_price_money":{"$ref":"#/components/schemas/Money"}},"type":"object"},"UpdateCatalogSettings":{"additionalProperties":false,"properties":{"default_delivery_profile_id":{"description":"Active delivery profile assigned to new physical catalog items.","type":"string"},"expected_version":{"description":"Catalog settings version returned by GET /v1/settings. Use 0 only when catalog settings do not exist yet.","format":"uint64","minimum":0,"type":"integer"}},"required":["default_delivery_profile_id"],"type":"object"},"UpdateCategoryRequest":{"properties":{"description":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"name":{"type":"string"}},"type":"object"},"UpdateCheckoutSessionRequest":{"properties":{"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]}},"type":"object"},"UpdateCreditNoteRequest":{"allOf":[{"anyOf":[{"not":{"required":["credit_note_lines"]}},{"required":["expected_version"]}]}],"properties":{"credit_note_lines":{"description":"Replaces all draft corrections atomically with other edits. Include credit_note_line_id to retain a line, omit it to create a line, and omit a member to remove it. Send [] to clear the draft. Null is not accepted.","items":{"$ref":"#/components/schemas/CreditNoteLineRequest"},"type":"array"},"expected_version":{"description":"Credit note version last read. Required when credit_note_lines is present.","format":"int64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"memo":{"maxLength":4096,"type":["string","null"]},"reason":{"enum":["returned_goods","order_adjustment","billing_error","goodwill","other"],"type":"string","x-enum-descriptions":["Returned goods.","Order adjustment.","Billing error.","Goodwill.","Other."],"x-flint-enum":"closed"}},"type":"object"},"UpdateCustomerAddressRequest":{"properties":{"address":{"$ref":"#/components/schemas/PostalAddress"},"label":{"type":"string"},"phone":{"type":"string"},"recipient_name":{"type":"string"}},"type":"object"},"UpdateCustomerRequest":{"allOf":[{"if":{"properties":{"tax_identity":{"anyOf":[{"type":"null"},{"required":["tax_ids"],"type":"object"}]}},"required":["tax_identity"]},"then":{"required":["expected_version"]}}],"properties":{"billing_address":{"$ref":"#/components/schemas/Address"},"default_invoice_payment_term_id":{"type":"string"},"expected_version":{"description":"Required when replacing tax_ids or clearing tax_identity. Stale versions return a conflict.","format":"uint64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"group_id":{"type":"string"},"internal_note":{"type":"string"},"is_verified":{"type":"boolean"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"name":{"type":"string"},"phone":{"type":"string"},"shipping_address":{"$ref":"#/components/schemas/Address"},"tax_exempt":{"type":"boolean"},"tax_identity":{"anyOf":[{"$ref":"#/components/schemas/TaxIdentityPatch"},{"type":"null"}]}},"type":"object"},"UpdateDeliveryFulfillmentDetails":{"properties":{"carrier":{"type":["string","null"]},"courier_pickup_at":{"description":"Time at which the courier collected the order.","format":"date-time","type":["string","null"]},"courier_pickup_window_duration_seconds":{"description":"Width of the promised courier pickup window, from 0 to 86400 seconds.","format":"int64","maximum":86400,"minimum":0,"type":["integer","null"]},"courier_provider_name":{"description":"Delivery network or merchant fleet provider handling the job.","maxLength":255,"type":["string","null"]},"courier_support_phone_number":{"description":"Buyer-safe support number for the courier or merchant fleet.","maxLength":30,"type":["string","null"]},"delivered_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]},"dispatched_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]},"dropoff_notes":{"description":"Driver-facing notes for the final handoff.","maxLength":2048,"type":["string","null"]},"expires_at":{"description":"Deadline after which an undelivered job should enter merchant review.","format":"date-time","type":["string","null"]},"external_delivery_id":{"description":"Stable delivery job ID owned by the courier or merchant dispatch system.","maxLength":255,"type":["string","null"]},"instructions":{"type":["string","null"]},"no_contact":{"description":"Whether the buyer requested a no-contact handoff.","type":["boolean","null"]},"prep_time_duration_seconds":{"description":"Expected preparation time before courier pickup, from 0 to 86400 seconds.","format":"int64","maximum":86400,"minimum":0,"type":["integer","null"]},"ready_at":{"description":"Time at which the order became ready for courier pickup.","format":"date-time","type":["string","null"]},"service_area_id":{"type":["string","null"]},"tracking_url":{"description":"Absolute HTTPS carrier tracking URL. Embedded URL credentials are rejected.","type":["string","null"]},"window_end_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]},"window_start_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]}},"type":"object"},"UpdateDeliveryLocationSetRequest":{"additionalProperties":false,"allOf":[{"anyOf":[{"not":{"required":["configuration"]}},{"required":["expected_version"]}]}],"anyOf":[{"required":["name"]},{"required":["external_reference_id"]},{"required":["configuration"]},{"required":["metadata"]}],"properties":{"configuration":{"$ref":"#/components/schemas/DeliveryLocationSetConfiguration"},"expected_version":{"description":"Current resource version. Required for configuration, owned-rate replacement, and quote-pinned method presentation; optional for other scalar and status updates.","format":"uint64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":["string","null"]},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"name":{"type":"string"}},"type":"object"},"UpdateDeliveryMethodRequest":{"additionalProperties":false,"allOf":[{"anyOf":[{"not":{"required":["configuration"]}},{"required":["expected_version"]}]},{"anyOf":[{"not":{"required":["name"]}},{"required":["expected_version"]}]},{"anyOf":[{"not":{"required":["description"]}},{"required":["expected_version"]}]},{"anyOf":[{"not":{"required":["display_position"]}},{"required":["expected_version"]}]},{"anyOf":[{"not":{"required":["recommendation_priority"]}},{"required":["expected_version"]}]}],"anyOf":[{"required":["name"]},{"required":["external_reference_id"]},{"required":["configuration"]},{"required":["metadata"]},{"required":["description"]},{"required":["display_position"]},{"required":["recommendation_priority"]},{"required":["status"]}],"not":{"anyOf":[{"required":["name"]},{"required":["external_reference_id"]},{"required":["configuration"]},{"required":["metadata"]},{"required":["description"]},{"required":["display_position"]},{"required":["recommendation_priority"]}],"required":["status"]},"properties":{"configuration":{"$ref":"#/components/schemas/DeliveryMethodConfigurationInput"},"description":{"type":"string"},"display_position":{"format":"int32","type":"integer"},"expected_version":{"description":"Current resource version. Required for configuration, owned-rate replacement, and quote-pinned method presentation; optional for other scalar and status updates.","format":"uint64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":["string","null"]},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"name":{"type":"string"},"recommendation_priority":{"format":"int32","type":["integer","null"]},"status":{"enum":["inactive","active"],"type":"string","x-enum-descriptions":["Inactive.","Active."],"x-flint-enum":"open"}},"type":"object"},"UpdateDeliveryProfileRequest":{"additionalProperties":false,"allOf":[{"anyOf":[{"not":{"required":["configuration"]}},{"required":["expected_version"]}]}],"anyOf":[{"required":["name"]},{"required":["external_reference_id"]},{"required":["configuration"]},{"required":["metadata"]}],"properties":{"configuration":{"$ref":"#/components/schemas/DeliveryProfileConfigurationInput"},"expected_version":{"description":"Current resource version. Required for configuration, owned-rate replacement, and quote-pinned method presentation; optional for other scalar and status updates.","format":"uint64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":["string","null"]},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"name":{"type":"string"}},"type":"object"},"UpdateDeliveryRateCallbackRequest":{"additionalProperties":false,"allOf":[{"anyOf":[{"not":{"required":["configuration"]}},{"required":["expected_version"]}]}],"anyOf":[{"required":["name"]},{"required":["external_reference_id"]},{"required":["configuration"]},{"required":["status"]}],"not":{"anyOf":[{"required":["name"]},{"required":["external_reference_id"]},{"required":["configuration"]}],"required":["status"]},"properties":{"configuration":{"$ref":"#/components/schemas/DeliveryRateCallbackConfiguration"},"expected_version":{"description":"Current resource version. Required for configuration, owned-rate replacement, and quote-pinned method presentation; optional for other scalar and status updates.","format":"uint64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":["string","null"]},"name":{"type":"string"},"status":{"enum":["inactive","active"],"type":"string","x-enum-descriptions":["Inactive.","Active."],"x-flint-enum":"open"}},"type":"object"},"UpdateDeliveryZoneRequest":{"additionalProperties":false,"allOf":[{"anyOf":[{"not":{"required":["configuration"]}},{"required":["expected_version"]}]}],"anyOf":[{"required":["name"]},{"required":["external_reference_id"]},{"required":["configuration"]},{"required":["metadata"]}],"properties":{"configuration":{"$ref":"#/components/schemas/DeliveryZoneConfiguration"},"expected_version":{"description":"Current resource version. Required for configuration, owned-rate replacement, and quote-pinned method presentation; optional for other scalar and status updates.","format":"uint64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":["string","null"]},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"name":{"type":"string"}},"type":"object"},"UpdateDeviceRequest":{"properties":{"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"name":{"type":"string"}},"type":"object"},"UpdateDigitalFulfillmentDetails":{"properties":{"delivered_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]},"delivery_url":{"type":["string","null"]}},"type":"object"},"UpdateFulfillmentRequest":{"description":"Provide at most one fulfillment details object: pickup_details, local_delivery_details, digital_details, or service_details. Shipment execution details belong to shipments and packages.","oneOf":[{"not":{"anyOf":[{"required":["pickup_details"]},{"required":["local_delivery_details"]},{"required":["digital_details"]},{"required":["service_details"]}]}},{"required":["pickup_details"]},{"required":["local_delivery_details"]},{"required":["digital_details"]},{"required":["service_details"]}],"properties":{"completed_at":{"description":"Completion evidence timestamp. Use only to correct completion evidence on an already completed fulfillment; complete pending fulfillments with POST /transitions.","format":"date-time","type":["string","null"]},"customer_id":{"type":["string","null"]},"device_id":{"type":["string","null"]},"digital_details":{"anyOf":[{"$ref":"#/components/schemas/UpdateDigitalFulfillmentDetails"},{"type":"null"}]},"expected_version":{"description":"Optional resource version last read by the caller.","format":"uint64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"local_delivery_details":{"anyOf":[{"$ref":"#/components/schemas/UpdateDeliveryFulfillmentDetails"},{"type":"null"}]},"location_id":{"type":["string","null"]},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"pickup_details":{"anyOf":[{"$ref":"#/components/schemas/UpdatePickupFulfillmentDetails"},{"type":"null"}]},"recipient":{"anyOf":[{"$ref":"#/components/schemas/FulfillmentRecipient"},{"type":"null"}]},"service_details":{"anyOf":[{"$ref":"#/components/schemas/UpdateServiceFulfillmentDetails"},{"type":"null"}]}},"type":"object"},"UpdateInventoryAllocationPolicyRequest":{"additionalProperties":false,"allOf":[{"anyOf":[{"not":{"required":["configuration"]}},{"required":["expected_version"]}]}],"properties":{"configuration":{"$ref":"#/components/schemas/InventoryAllocationPolicyConfiguration"},"expected_version":{"format":"uint64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":["string","null"]},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"name":{"type":"string"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"}},"type":"object"},"UpdateInventoryCountRequest":{"additionalProperties":false,"allOf":[{"anyOf":[{"not":{"required":["observations"]}},{"required":["expected_version"]}]}],"properties":{"expected_version":{"format":"uint64","minimum":1,"type":"integer"},"external_actor_id":{"type":"string"},"observations":{"items":{"$ref":"#/components/schemas/InventoryCountObservationInput"},"maxItems":100,"minItems":1,"type":"array"},"occurred_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"source_system":{"$ref":"#/components/schemas/InventorySourceSystemInput"}},"required":["observations"],"type":"object"},"UpdateInventoryItemRequest":{"properties":{"barcode":{"type":["string","null"]},"expected_version":{"format":"uint64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":["string","null"]},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","items":{"minimum":0,"type":"integer"},"type":["object","null"]},"name":{"type":"string"},"sku":{"type":["string","null"]},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"}},"type":"object"},"UpdateInventoryLevelRequest":{"additionalProperties":false,"properties":{"expected_version":{"format":"uint64","minimum":1,"type":"integer"},"safety_stock_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","minimum":0,"type":"integer"}},"required":["safety_stock_quantity"],"type":"object"},"UpdateInventoryTransferRequest":{"additionalProperties":false,"properties":{"expected_version":{"format":"uint64","minimum":1,"type":"integer"},"external_reference":{"type":["string","null"]},"line_changes":{"items":{"discriminator":{"propertyName":"operation"},"oneOf":[{"additionalProperties":false,"properties":{"inventory_item_id":{"type":"string"},"operation":{"enum":["add"],"type":"string","x-enum-descriptions":["Add."],"x-flint-enum":"closed"},"physical_condition":{"default":"sellable","enum":["sellable","quality_control","damaged","quarantined"],"type":"string","x-enum-descriptions":["Sellable.","Quality control.","Damaged.","Quarantined."],"x-flint-enum":"closed"},"requested_quantity":{"format":"int64","minimum":1,"type":"integer"}},"required":["operation","inventory_item_id","requested_quantity"],"type":"object"},{"additionalProperties":false,"properties":{"inventory_transfer_line_id":{"type":"string"},"operation":{"enum":["update"],"type":"string","x-enum-descriptions":["Update."],"x-flint-enum":"closed"},"requested_quantity":{"format":"int64","minimum":1,"type":"integer"}},"required":["operation","inventory_transfer_line_id","requested_quantity"],"type":"object"},{"additionalProperties":false,"properties":{"inventory_transfer_line_id":{"type":"string"},"operation":{"enum":["remove"],"type":"string","x-enum-descriptions":["Remove."],"x-flint-enum":"closed"}},"required":["operation","inventory_transfer_line_id"],"type":"object"}]},"maxItems":100,"minItems":1,"type":"array"},"note":{"type":["string","null"]}},"type":"object"},"UpdateInvoicePaymentTermRequest":{"additionalProperties":false,"minProperties":1,"properties":{"calculation":{"$ref":"#/components/schemas/InvoicePaymentTermCalculation"},"expected_version":{"description":"Optional version last read by the caller.","format":"uint32","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"late_fee_policy":{"anyOf":[{"$ref":"#/components/schemas/InvoiceLateFeePolicy"},{"type":"null"}]},"name":{"type":"string"}},"type":"object"},"UpdateInvoiceRequest":{"allOf":[{"anyOf":[{"not":{"required":["schedule_entries"]}},{"required":["expected_version"]}]}],"properties":{"cc_emails":{"items":{"type":"string"},"type":"array"},"collection":{"$ref":"#/components/schemas/InvoiceCollectionInput"},"expected_version":{"description":"Invoice version last read. Required when schedule_entries is present.","format":"int64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"footer":{"type":"string"},"memo":{"type":"string"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"payment_due":{"$ref":"#/components/schemas/InvoicePaymentDueInput"},"po_number":{"type":"string"},"recipient_email":{"type":"string"},"reference":{"type":"string"},"remit_to_address":{"$ref":"#/components/schemas/Address"},"schedule_entries":{"description":"Complete draft payment schedule with at most 14 entries. Omission preserves the current or default schedule; [] clears the authored schedule. Null is not accepted. On PATCH, include invoice_schedule_entry_id to retain an entry and expected_version to detect concurrent edits.","items":{"$ref":"#/components/schemas/InvoiceScheduleEntryWrite"},"maxItems":14,"type":"array"},"scheduled_send_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"service_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"type":"object"},"UpdateLineItemRequest":{"anyOf":[{"not":{"required":["modifiers"]}},{"required":["modifiers","expected_version"]}],"properties":{"description":{"type":"string"},"expected_version":{"format":"int64","minimum":1,"type":"integer"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"modifiers":{"items":{"$ref":"#/components/schemas/OrderLineItemModifierInput"},"type":"array"},"name":{"type":"string"},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"tax":{"$ref":"#/components/schemas/OrderCalculatedLineItemTax"},"unit_price_money":{"$ref":"#/components/schemas/Money"}},"type":"object"},"UpdateLocationInventoryRequest":{"additionalProperties":false,"properties":{"allocation_status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"expected_inventory_revision":{"format":"uint64","minimum":1,"type":"integer"}},"required":["allocation_status"],"type":"object"},"UpdateLocationRequest":{"properties":{"expected_version":{"format":"uint64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":["string","null"]},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","items":{"minimum":0,"type":"integer"},"type":["object","null"]},"name":{"type":"string"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"}},"type":"object"},"UpdateMeRequest":{"properties":{"name":{"type":"string"},"phone":{"type":"string"}},"type":"object"},"UpdateMerchantRequest":{"properties":{"address":{"$ref":"#/components/schemas/Address"},"api_version":{"description":"Set the merchant default to any supported API version. Omit to leave it unchanged. Null is not accepted. The default is shared across live and test environments; requests with Flint-Version use that header instead.","type":"string"},"email":{"type":"string"},"expected_version":{"description":"Merchant profile version last read. A different current version returns MERCHANT_CHANGED. Send this value when saving a logo to detect concurrent profile edits.","format":"int64","minimum":1,"type":"integer"},"logo":{"$ref":"#/components/schemas/ImageInput"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"organization_id":{"type":"string"},"phone":{"type":"string"},"support_email":{"type":"string"},"support_phone":{"description":"Support phone in E.164 format, for example +12125551234. Send an empty string to clear the phone number.","maxLength":16,"pattern":"^$|^\\+[1-9][0-9]{6,14}$","type":"string"},"support_url":{"type":"string"},"website_url":{"type":"string"}},"type":"object"},"UpdateModifierGroupRequest":{"anyOf":[{"not":{"required":["modifiers"]}},{"required":["expected_version"]}],"properties":{"allow_quantities":{"type":"boolean"},"expected_version":{"description":"Modifier group version last read by the caller. Required when modifiers is present.","format":"uint64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"max_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"max_selected":{"format":"int32","type":"integer"},"max_total_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"min_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"min_selected":{"format":"int32","type":"integer"},"modifiers":{"description":"Replaces all modifiers atomically. Include modifier_id to retain an existing modifier, omit the ID to create one, and omit a previous modifier to archive it. Omit the array to leave modifiers unchanged. An empty array clears modifiers when the group rules permit it. Null is not accepted.","items":{"$ref":"#/components/schemas/ModifierInput"},"type":"array"},"name":{"type":"string"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"text":{"$ref":"#/components/schemas/TextModifierConfigInput"}},"type":"object"},"UpdateModifierSetRequest":{"anyOf":[{"not":{"required":["modifier_groups"]}},{"required":["modifier_groups","expected_version"]}],"properties":{"expected_version":{"format":"uint64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"modifier_groups":{"items":{"$ref":"#/components/schemas/ModifierSetGroupInput"},"type":"array"},"name":{"type":"string"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"}},"type":"object"},"UpdateOrderChargeRequest":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"calculation_basis":{"enum":["subtotal_pre_discount","subtotal_post_discount"],"type":"string","x-enum-descriptions":["Subtotal pre discount.","Subtotal post discount."],"x-flint-enum":"closed"},"description":{"type":"string"},"fulfillment_id":{"type":"string"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"name":{"type":"string"},"percent":{"multipleOf":0.0001,"type":"number"},"tax":{"$ref":"#/components/schemas/OrderCalculatedChargeTax"},"type":{"enum":["service_fee","delivery_fee","shipping_fee","handling_fee","packaging_fee","small_order_fee","service_area_fee","setup_fee","installation_fee","cleaning_fee","booking_fee","reservation_fee","ticket_fee","fulfillment_fee","restocking_fee","rush_fee","other"],"type":"string","x-enum-descriptions":["Service fee.","Delivery fee.","Shipping fee.","Handling fee.","Packaging fee.","Small order fee.","Service area fee.","Setup fee.","Installation fee.","Cleaning fee.","Booking fee.","Reservation fee.","Ticket fee.","Fulfillment fee.","Restocking fee.","Rush fee.","Other."],"x-flint-enum":"closed"}},"type":"object"},"UpdateOrderRequest":{"additionalProperties":false,"minProperties":1,"properties":{"buyer_note":{"type":"string"},"customer_id":{"type":"string"},"delivery_destination":{"anyOf":[{"$ref":"#/components/schemas/OrderDeliveryDestinationInput"},{"type":"null"}],"description":"Complete replacement destination. Allowed only while the order is open and unpaid and no delivery selection controls it."},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"internal_note":{"type":"string"},"inventory_routing_source":{"$ref":"#/components/schemas/OrderInventoryRoutingSourceInput"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"requested_tip":{"anyOf":[{"$ref":"#/components/schemas/CreateOrderTip"},{"type":"null"}],"description":"Requested tip to set or replace. Send null to clear the current requested tip."},"tax":{"$ref":"#/components/schemas/OrderTaxInput"}},"type":"object"},"UpdateOrganizationRequest":{"properties":{"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"name":{"type":"string"},"parent_organization_id":{"type":"string"}},"type":"object"},"UpdatePackageItemRequest":{"properties":{"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"}},"type":"object"},"UpdatePackageRequest":{"properties":{"buyer_notification_behavior":{"description":"Controls buyer email handling. Omit or use send to send when recipient, template, and deduplication rules allow it. Use suppress when another system owns buyer messaging.","enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"carrier":{"type":["string","null"]},"dimensions":{"anyOf":[{"$ref":"#/components/schemas/ShippingDimensions"},{"type":"null"}]},"expected_version":{"description":"Optional resource version last read by the caller.","format":"uint64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system. Caller-owned package identifier in external_system. Set with external_system to enable duplicate detection and replay for that provider reference.","maxLength":255,"minLength":1,"type":["string","null"]},"external_system":{"description":"External carrier, aggregator, or fulfillment platform name for this package. Set with external_reference_id to enable duplicate detection and replay for that provider reference; without external_reference_id this is stored as provenance only.","type":["string","null"]},"label_url":{"description":"Merchant or integration supplied HTTPS shipping-label URL for authenticated merchant workflows. Non-Flint URLs must include external_system for provenance. Flint does not currently manage label file hosting or buyer-facing label downloads.","type":["string","null"]},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"service_code":{"type":["string","null"]},"status_reason":{"type":["string","null"]},"tracking_number":{"type":["string","null"]},"tracking_url":{"description":"Absolute HTTPS carrier tracking URL. Embedded URL credentials are rejected.","type":["string","null"]},"weight":{"anyOf":[{"$ref":"#/components/schemas/ShippingWeight"},{"type":"null"}]}},"type":"object"},"UpdatePackageResponse":{"properties":{"data":{"$ref":"#/components/schemas/UpdatePackageResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"UpdatePackageResult":{"properties":{"fulfillment_event":{"$ref":"#/components/schemas/FulfillmentEvent"},"fulfillment_notifications":{"items":{"$ref":"#/components/schemas/FulfillmentNotification"},"type":"array"},"package":{"$ref":"#/components/schemas/Package"}},"required":["package"],"type":"object"},"UpdatePartnerAppRequest":{"properties":{"api_version":{"type":"string"},"expected_api_version":{"description":"Apply api_version only if this matches the resource's current api_version. A mismatch returns HTTP 409. Requires api_version; null is not accepted.","type":"string"}},"type":"object"},"UpdatePaymentIntentRequest":{"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"customer_id":{"type":"string"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"receipt_email":{"type":"string"},"tip_money":{"$ref":"#/components/schemas/Money"}},"type":"object"},"UpdatePaymentLinkRequest":{"allOf":[{"anyOf":[{"not":{"required":["line_items"]}},{"required":["expected_version"]}]},{"anyOf":[{"not":{"required":["custom_fields"]}},{"required":["expected_version"]}]},{"anyOf":[{"not":{"required":["delivery_method_ids"]}},{"required":["expected_version"]}]}],"properties":{"custom_fields":{"description":"Replaces all custom fields atomically. Include an existing payment_link_custom_field_id to retain that member, omit the ID to create a member, and omit a previous member to remove it. Send an empty array to clear all custom fields, omit custom_fields to leave it unchanged, and do not send null.","items":{"$ref":"#/components/schemas/PaymentLinkCustomFieldPatchInput"},"type":"array"},"custom_text":{"$ref":"#/components/schemas/CheckoutCustomTextWriteConfig"},"customer_collection":{"$ref":"#/components/schemas/PaymentLinkCustomerConfig"},"delivery_method_ids":{"description":"Complete delivery method selection for the link. Send an empty array to clear it. Omit it on PATCH to leave the selection unchanged. Null and duplicate IDs are not accepted.","items":{"type":"string"},"maxItems":25,"type":"array","uniqueItems":true},"description":{"type":"string"},"donation_max_amount_money":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}],"description":"Maximum donation amount. Send null to clear the maximum."},"donation_min_amount_money":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}],"description":"Minimum donation amount. Send null to clear the minimum."},"donation_suggested_amount_money_options":{"description":"Suggested donation amounts. Send an empty array to clear suggested amounts.","items":{"$ref":"#/components/schemas/Money"},"type":"array"},"event_config":{"$ref":"#/components/schemas/PaymentLinkEventConfig"},"expected_version":{"description":"Payment link version last read by the caller. Required when line_items, custom_fields, or delivery_method_ids is present.","format":"int64","minimum":1,"type":"integer"},"expiration":{"$ref":"#/components/schemas/CheckoutExpirationConfig"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"image":{"anyOf":[{"$ref":"#/components/schemas/ImageInput"},{"type":"null"}]},"inactive_message":{"type":"string"},"inventory_routing_source":{"$ref":"#/components/schemas/InventoryRoutingSourceInput"},"legal":{"$ref":"#/components/schemas/CheckoutLegalConfig"},"line_items":{"description":"Replaces all line items atomically. Include an existing payment_link_line_item_id to retain that member, omit the ID to create a member, and omit a previous member to remove it. Omit line_items to leave it unchanged. Null is not accepted.","items":{"$ref":"#/components/schemas/PaymentLinkLineItemPatchInput"},"minItems":1,"type":"array"},"max_completions":{"format":"int32","type":"integer"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"name":{"type":"string"},"payments":{"$ref":"#/components/schemas/CheckoutPaymentConfig"},"promotion_config":{"$ref":"#/components/schemas/CheckoutPromotionConfig"},"redirects":{"$ref":"#/components/schemas/CheckoutRedirectsConfig"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"tax":{"$ref":"#/components/schemas/CheckoutTaxConfig"},"theme":{"$ref":"#/components/schemas/ThemeConfig"},"tip":{"$ref":"#/components/schemas/CheckoutTipConfig"}},"type":"object"},"UpdatePaymentMethodDomainRequest":{"properties":{"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"}},"required":["status"],"type":"object"},"UpdatePayoutDestinationRequest":{"properties":{"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]}},"type":"object"},"UpdatePayoutSettingsRequest":{"properties":{"default_payout_destinations":{"additionalProperties":{"type":"string"},"type":"object"},"delay_days_override":{"format":"int32","type":["integer","null"]},"interval":{"enum":["manual","daily","weekly","monthly"],"type":"string","x-enum-descriptions":["Manual.","Daily.","Weekly.","Monthly."],"x-flint-enum":"closed"},"minimum_balance_by_currency":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"type":"object"},"monthly_payout_days":{"items":{"format":"int32","type":"integer"},"type":"array"},"statement_descriptor":{"type":"string"},"weekly_payout_days":{"items":{"type":"string"},"type":"array"}},"type":"object"},"UpdatePickupFulfillmentDetails":{"properties":{"address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]},"curbside_instructions":{"description":"Instructions specific to curbside handoff.","maxLength":2048,"type":["string","null"]},"customer_arrived_at":{"description":"Buyer-reported arrival time for curbside or counter pickup.","format":"date-time","type":["string","null"]},"expires_at":{"description":"Deadline after which an uncollected pickup should enter merchant review.","format":"date-time","type":["string","null"]},"instructions":{"type":["string","null"]},"location_name":{"type":["string","null"]},"picked_up_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]},"pickup_window_duration_seconds":{"description":"Width of the promised pickup window, from 0 to 86400 seconds.","format":"int64","maximum":86400,"minimum":0,"type":["integer","null"]},"prep_time_duration_seconds":{"description":"Expected preparation time for restaurant and made-to-order pickup, from 0 to 86400 seconds.","format":"int64","maximum":86400,"minimum":0,"type":["integer","null"]},"ready_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]},"vehicle_description":{"description":"Buyer vehicle description used for curbside handoff.","maxLength":500,"type":["string","null"]},"window_end_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]},"window_start_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]}},"type":"object"},"UpdateProductOptionInput":{"properties":{"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Complete caller-owned metadata for this option. Retained options are replaced as members of the options array, so omitting metadata, sending null, or sending {} clears it. A null-valued key is omitted from the replacement. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"name":{"maxLength":255,"minLength":1,"type":"string"},"option_id":{"pattern":"^opt_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"position":{"format":"int32","minimum":0,"type":"integer"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"values":{"items":{"$ref":"#/components/schemas/UpdateProductOptionValueInput"},"type":"array"}},"required":["name"],"type":"object"},"UpdateProductOptionValueInput":{"properties":{"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Complete caller-owned metadata for this option value. Retained option values are replaced as members of the options array, so omitting metadata, sending null, or sending {} clears it. A null-valued key is omitted from the replacement. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"option_value_id":{"pattern":"^optv_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"position":{"format":"int32","minimum":0,"type":"integer"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"value":{"maxLength":255,"minLength":1,"type":"string"}},"required":["value"],"type":"object"},"UpdateProductRequest":{"allOf":[{"anyOf":[{"not":{"required":["categories"]}},{"required":["expected_version"]}]},{"anyOf":[{"not":{"required":["options"]}},{"required":["expected_version"]}]},{"anyOf":[{"not":{"required":["images"]}},{"required":["expected_version"]}]}],"properties":{"categories":{"items":{"maxLength":100,"minLength":1,"type":"string"},"maxItems":100,"type":"array"},"default_variant_id":{"type":"string"},"description":{"type":"string"},"expected_version":{"description":"Resource version last read by the caller. Required when replacing an owned collection.","format":"uint64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"images":{"description":"The complete desired gallery in display order. The first image is primary. Send [] to clear the gallery.","items":{"$ref":"#/components/schemas/ImageInput"},"maxItems":8,"minItems":0,"type":"array"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"modifier_set_id":{"description":"Attached modifier set. Send null on update to remove it.","pattern":"^ms_[0-9A-HJKMNP-TV-Z]{26}$","type":["string","null"]},"name":{"type":"string"},"options":{"description":"Replaces all product options and values atomically. Include existing option_id and option_value_id values to retain members. Omitted members are archived. Null is not accepted.","items":{"$ref":"#/components/schemas/UpdateProductOptionInput"},"type":"array"},"product_type":{"enum":["physical","service","fee","digital"],"type":"string","x-enum-descriptions":["Physical.","Service.","Fee.","Digital."],"x-flint-enum":"closed"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"}},"type":"object"},"UpdateProductVariantRequest":{"allOf":[{"anyOf":[{"not":{"required":["images"]}},{"required":["expected_version"]}]}],"properties":{"barcode":{"type":"string"},"delivery_profile_id":{"type":"string"},"expected_version":{"description":"Resource version last read by the caller. Required when replacing an owned collection.","format":"uint64","minimum":1,"type":"integer"},"images":{"description":"Replaces the authored variant gallery atomically. Send [] to clear it and resume product-image inheritance.","items":{"$ref":"#/components/schemas/ImageInput"},"maxItems":8,"minItems":0,"type":"array"},"inventory_item":{"$ref":"#/components/schemas/InventoryItemCreateInput"},"inventory_item_id":{"description":"Inventory item tracked by this variant. Send null to stop tracking inventory.","type":["string","null"]},"line_item_tax_category":{"description":"Flint line-item tax category.","enum":["general","physical_goods","digital_goods","software","saas","services","professional_services","food","prepared_food","clothing","medical_goods","admission"],"type":"string","x-enum-descriptions":["General.","Physical goods.","Digital goods.","Software.","Saas.","Services.","Professional services.","Food.","Prepared food.","Clothing.","Medical goods.","Admission."],"x-flint-enum":"closed"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"modifier_set_id":{"description":"Attached modifier set. Send null on update to remove it.","pattern":"^ms_[0-9A-HJKMNP-TV-Z]{26}$","type":["string","null"]},"name":{"type":"string"},"position":{"format":"int32","type":"integer"},"sku":{"type":"string"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"},"taxable":{"type":"boolean"},"unit_price_money":{"$ref":"#/components/schemas/Money"}},"type":"object"},"UpdatePromotionCodeRequest":{"properties":{"expires_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"max_uses":{"format":"int64","type":"integer"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"status":{"description":"Stored code switch. Only active and inactive can be set; expired and exhausted are computed on reads.","enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"}},"type":"object"},"UpdatePromotionRequest":{"properties":{"application_method":{"$ref":"#/components/schemas/PromotionApplicationMethod"},"combines_with":{"$ref":"#/components/schemas/PromotionCombinesWith"},"description":{"type":"string"},"discount_class":{"description":"Promotion discount class.","enum":["order","line_item","service_charge"],"type":"string","x-enum-descriptions":["Order.","Line item.","Service charge."],"x-flint-enum":"closed"},"display_name":{"description":"Buyer-facing promotion name shown in checkout and order discount surfaces.","type":"string"},"eligibility_rules":{"$ref":"#/components/schemas/PromotionRuleGroup"},"exclusivity":{"$ref":"#/components/schemas/PromotionExclusivity"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"max_uses":{"format":"int64","type":"integer"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"name":{"description":"Internal promotion name for dashboards, searching, and reporting.","type":"string"},"schedule":{"$ref":"#/components/schemas/PromotionSchedule"},"stacking_mode":{"enum":["continue","stop_after"],"type":"string","x-enum-descriptions":["Continue.","Stop after."],"x-flint-enum":"closed"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"}},"type":"object"},"UpdateRefundRequest":{"properties":{"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]}},"type":"object"},"UpdateReturnLineItemRequest":{"additionalProperties":false,"properties":{"buyer_note":{"type":["string","null"]},"expected_version":{"format":"int64","minimum":1,"type":"integer"},"requested_quantity":{"description":"Whole-number quantity; fractional quantities are not supported.","format":"int64","type":"integer"},"requested_resolution_type":{"enum":["refund","exchange","replacement","no_monetary_action",null],"type":["string","null"],"x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action.","Null."],"x-flint-enum":"closed"},"return_reason_id":{"type":"string"}},"type":"object"},"UpdateReturnLineItemResponse":{"properties":{"data":{"$ref":"#/components/schemas/Return"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"UpdateReturnPolicyRequest":{"additionalProperties":false,"properties":{"expected_version":{"format":"int64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":["string","null"]},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"name":{"type":"string"},"status":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"}},"type":"object"},"UpdateReturnPolicyResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnPolicy"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"UpdateReturnReasonRequest":{"additionalProperties":false,"allOf":[{"anyOf":[{"not":{"required":["category_handles"]}},{"required":["expected_version"]}]}],"properties":{"category_handles":{"items":{"type":"string"},"type":"array"},"description":{"type":["string","null"]},"expected_version":{"format":"int64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":["string","null"]},"is_note_required":{"type":"boolean"},"name":{"type":"string"}},"type":"object"},"UpdateReturnReasonResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnReason"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"UpdateReturnRequest":{"additionalProperties":false,"properties":{"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":["string","null"]},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]}},"type":"object"},"UpdateReturnResolutionRequest":{"additionalProperties":false,"allOf":[{"anyOf":[{"not":{"required":["line_items"]}},{"required":["expected_version"]}]},{"anyOf":[{"not":{"required":["replacement_line_items"]}},{"required":["expected_version"]}]},{"anyOf":[{"not":{"required":["adjustment_set"]}},{"required":["expected_version"]}]}],"properties":{"adjustment_set":{"$ref":"#/components/schemas/ReturnResolutionAdjustmentSet"},"expected_version":{"format":"int64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"minLength":1,"type":["string","null"]},"line_items":{"items":{"$ref":"#/components/schemas/ReturnResolutionLineItemReplacementInput"},"type":"array"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"pricing_basis":{"enum":["original_price","current_price","merchant_agreed_price"],"type":"string","x-enum-descriptions":["Original price.","Current price.","Merchant agreed price."],"x-flint-enum":"closed"},"replacement_line_items":{"items":{"$ref":"#/components/schemas/ReturnReplacementLineItemReplacementInput"},"type":"array"}},"type":"object"},"UpdateReturnResolutionResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnResolution"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"UpdateReturnResponse":{"properties":{"data":{"$ref":"#/components/schemas/Return"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"UpdateRiskListRequest":{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"UpdateRiskRuleRequest":{"anyOf":[{"required":["action"]},{"required":["predicate"]},{"required":["description"]},{"required":["enabled"]}],"properties":{"action":{"enum":["allow","block","review","require_3ds"],"type":"string","x-enum-descriptions":["Allow.","Block.","Review.","Require 3ds."],"x-flint-enum":"closed"},"description":{"type":"string"},"enabled":{"type":"boolean"},"expected_version":{"description":"Optional risk rule version last read by the caller.","format":"int64","minimum":1,"type":"integer"},"predicate":{"$ref":"#/components/schemas/RiskPredicateNode"}},"type":"object"},"UpdateServiceFulfillmentDetails":{"properties":{"completed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]},"notes":{"type":["string","null"]},"scheduled_end_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]},"scheduled_start_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]}},"type":"object"},"UpdateSettingsRequest":{"allOf":[{"if":{"properties":{"tax_identity":{"anyOf":[{"type":"null"},{"required":["tax_ids"],"type":"object"}]}},"required":["tax_identity"]},"then":{"required":["expected_version"]}}],"not":{"anyOf":[{"required":["branding"]},{"required":["checkout"]},{"required":["customer_account"]},{"required":["customer_email_delivery"]},{"required":["expected_version"]},{"required":["fulfillment"]},{"required":["inventory"]},{"required":["invoices"]},{"required":["legal"]},{"required":["metadata"]},{"required":["promotions"]},{"required":["receipts"]},{"required":["subscriptions"]},{"required":["tax"]},{"required":["tax_identity"]},{"required":["tipping"]}],"required":["catalog"]},"properties":{"branding":{"$ref":"#/components/schemas/BrandingSettings"},"catalog":{"$ref":"#/components/schemas/UpdateCatalogSettings"},"checkout":{"$ref":"#/components/schemas/CheckoutSettings"},"customer_account":{"$ref":"#/components/schemas/CustomerAccountSettings"},"customer_email_delivery":{"$ref":"#/components/schemas/CustomerEmailDeliverySettings"},"expected_version":{"description":"Required when replacing tax_ids or clearing tax_identity. Stale versions return a conflict.","format":"uint64","minimum":1,"type":"integer"},"fulfillment":{"$ref":"#/components/schemas/FulfillmentSettings"},"inventory":{"$ref":"#/components/schemas/InventorySettings"},"invoices":{"anyOf":[{"$ref":"#/components/schemas/InvoiceSettingsPatch"},{"type":"null"}]},"legal":{"$ref":"#/components/schemas/LegalSettings"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"promotions":{"$ref":"#/components/schemas/PromotionSettings"},"receipts":{"$ref":"#/components/schemas/ReceiptSettings"},"subscriptions":{"$ref":"#/components/schemas/SubscriptionSettings"},"tax":{"$ref":"#/components/schemas/TaxSettings"},"tax_identity":{"anyOf":[{"$ref":"#/components/schemas/TaxIdentityPatch"},{"type":"null"}]},"tipping":{"$ref":"#/components/schemas/TippingSettings"}},"type":"object"},"UpdateShipmentRequest":{"properties":{"expected_version":{"description":"Optional resource version last read by the caller.","format":"uint64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system. Caller-owned shipment identifier in external_system. Set with external_system to enable duplicate detection and replay for that provider reference.","maxLength":255,"minLength":1,"type":["string","null"]},"external_system":{"description":"External carrier, aggregator, or fulfillment platform name for this shipment. Set with external_reference_id to enable duplicate detection and replay for that provider reference; without external_reference_id this is stored as provenance only.","type":["string","null"]},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]}},"type":"object"},"UpdateShipmentResponse":{"properties":{"data":{"$ref":"#/components/schemas/UpdateShipmentResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"UpdateShipmentResult":{"properties":{"shipment":{"$ref":"#/components/schemas/Shipment"}},"required":["shipment"],"type":"object"},"UpdateSubscriptionBillingScheduleRequest":{"description":"A closed owner-specific billing schedule update.","discriminator":{"propertyName":"owner"},"oneOf":[{"additionalProperties":false,"properties":{"billing_anchor_day":{"format":"int32","type":"integer"},"initiated_by":{"enum":["buyer","merchant","integration"],"type":"string","x-enum-descriptions":["Buyer.","Merchant.","Integration."],"x-flint-enum":"closed"},"next_billing_at":{"description":"Future date at which Flint attempts the next charge.","format":"date-time","type":"string"},"owner":{"enum":["flint"],"type":"string","x-enum-descriptions":["Flint."],"x-flint-enum":"closed"}},"required":["owner","initiated_by","next_billing_at"],"type":"object"},{"additionalProperties":false,"properties":{"initiated_by":{"enum":["buyer","merchant","integration"],"type":"string","x-enum-descriptions":["Buyer.","Merchant.","Integration."],"x-flint-enum":"closed"},"next_billing_at":{"description":"Future date at which Flint attempts the next charge. Omit to preserve the date or send null to clear it.","format":"date-time","type":["string","null"]},"owner":{"enum":["external"],"type":"string","x-enum-descriptions":["External."],"x-flint-enum":"closed"}},"required":["owner","initiated_by"],"type":"object"}]},"UpdateSubscriptionPlanLineItemInput":{"additionalProperties":false,"oneOf":[{"not":{"anyOf":[{"required":["bundle_id"]},{"required":["name"]},{"required":["unit_price_money"]},{"required":["description"]},{"required":["tax"]}]},"required":["variant_id"]},{"not":{"anyOf":[{"required":["variant_id"]},{"required":["name"]},{"required":["unit_price_money"]},{"required":["description"]},{"required":["tax"]}]},"required":["bundle_id"]},{"not":{"anyOf":[{"required":["variant_id"]},{"required":["bundle_id"]}]},"required":["name","unit_price_money"]}],"properties":{"bundle_id":{"type":"string"},"description":{"type":"string"},"modifiers":{"items":{"allOf":[{"$ref":"#/components/schemas/OrderLineItemModifierInput"},{"not":{"required":["order_line_item_modifier_id"]}}]},"type":"array"},"name":{"type":"string"},"quantity":{"default":1,"description":"Whole-number quantity; fractional quantities are not supported. Omission uses 1.","format":"int32","maximum":9999,"minimum":1,"type":"integer"},"subscription_plan_line_item_id":{"description":"ID of an existing item on this plan to retain. Omit for a new item. Duplicate IDs and IDs from other plans are rejected.","type":"string"},"tax":{"$ref":"#/components/schemas/OrderLineItemTax"},"unit_price_money":{"$ref":"#/components/schemas/Money"},"variant_id":{"type":"string"}},"type":"object"},"UpdateSubscriptionPlanRequest":{"allOf":[{"anyOf":[{"not":{"required":["images"]}},{"required":["expected_version"]}]},{"anyOf":[{"not":{"required":["line_items"]}},{"required":["expected_version"]}]}],"properties":{"contract_term_months":{"format":"int32","type":"integer"},"description":{"type":"string"},"early_termination_fee_money":{"$ref":"#/components/schemas/Money"},"expected_version":{"description":"Resource version last read by the caller. Required when replacing an owned collection.","format":"uint64","minimum":1,"type":"integer"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"images":{"description":"The complete desired gallery in display order. The first image is primary. Send [] to clear the gallery.","items":{"$ref":"#/components/schemas/ImageInput"},"maxItems":8,"minItems":0,"type":"array"},"line_items":{"description":"Replaces all owned plan line items atomically. Requires expected_version. Omission leaves items unchanged; an empty array or null is invalid. Include subscription_plan_line_item_id to retain an item; omit it for a new server-generated ID. Omitted members are removed. Existing subscriptions keep their snapshots. Retained catalog items with the same source keep their catalog snapshot; omitted modifiers keep their recorded choices.","items":{"$ref":"#/components/schemas/UpdateSubscriptionPlanLineItemInput"},"minItems":1,"type":"array"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"name":{"type":"string"},"setup_fee_money":{"$ref":"#/components/schemas/Money"},"trial_period_days":{"format":"int32","type":"integer"}},"type":"object"},"UpdateSubscriptionRequest":{"properties":{"cancel_at_period_end":{"type":"boolean"},"external_reference_id":{"description":"Caller-owned identifier for this resource in an external system.","maxLength":255,"type":"string"},"metadata":{"additionalProperties":{"type":["string","null"]},"description":"Caller-owned metadata. Omit this field to leave metadata unchanged. Send an object to merge by key, set a key to null to remove it, or set metadata to null to clear all metadata. An empty object makes no change. Empty strings are stored. Keys starting with flint_ are reserved and cannot be written through the public API.","type":["object","null"]},"payment_method_id":{"type":"string"}},"type":"object"},"UpdateWebhookEndpointRequest":{"properties":{"api_version":{"description":"Set default to follow the merchant default, or a supported YYYY-MM-DD version to pin this endpoint. Omit to leave unchanged. Null is not accepted. Switching between a pin and default clears the rollback offer.","type":"string"},"description":{"type":"string"},"enabled":{"type":"boolean"},"enabled_events":{"description":"Event types this endpoint receives. Empty means all merchant-owned events. For partner_app sources, empty defaults to all app lifecycle events. For installed_merchants sources, provide at least one installed-merchant event.","items":{"type":"string"},"type":"array"},"event_sources":{"description":"Event sources this endpoint receives. Defaults to merchant. Use partner_app for app lifecycle events and installed_merchants for events from merchants that installed the partner app.","items":{"enum":["merchant","partner_app","installed_merchants"],"type":"string","x-enum-descriptions":["Merchant.","Partner app.","Installed merchants."],"x-flint-enum":"closed"},"type":"array"},"expected_api_version":{"description":"Apply api_version only if this matches the resource's current api_version. A mismatch returns HTTP 409. Requires api_version; null is not accepted.","type":"string"},"mode":{"description":"Partner-source delivery mode. Valid values are test, live, and both. Mode applies to installed_merchants events; partner_app lifecycle events require both.","enum":["test","live","both"],"type":"string","x-enum-descriptions":["Test.","Live.","Both."],"x-flint-enum":"closed"},"partner_app_id":{"description":"Partner app that owns partner_app or installed_merchants event sources.","type":"string"},"url":{"type":"string"}},"type":"object"},"User":{"properties":{"banners":{"items":{"$ref":"#/components/schemas/Banner"},"readOnly":true,"type":"array"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"default_merchant_id":{"readOnly":true,"type":"string"},"email":{"readOnly":true,"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"status":{"enum":["active","deactivated"],"readOnly":true,"type":"string","x-enum-descriptions":["Active.","Deactivated."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"user_id":{"readOnly":true,"type":"string"}},"required":["email","first_name","last_name","status","user_id"],"type":"object"},"VerifyReturnReceiptLineItemRequest":{"additionalProperties":false,"properties":{"expected_version":{"format":"int64","minimum":1,"type":"integer"},"return_line_item_id":{"type":"string"},"verification_reason":{"enum":["order_match_confirmed","sku_match_confirmed","inspection_confirmed","merchant_review","other"],"type":"string","x-enum-descriptions":["Order match confirmed.","Sku match confirmed.","Inspection confirmed.","Merchant review.","Other."],"x-flint-enum":"closed"},"verification_reason_message":{"type":"string"}},"required":["return_line_item_id","verification_reason"],"type":"object"},"VerifyReturnReceiptLineItemResponse":{"properties":{"data":{"$ref":"#/components/schemas/ReturnReceipt"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"VoidPackageRequest":{"properties":{"buyer_notification_behavior":{"description":"Controls buyer email handling. Omit or use send to send when recipient, template, and deduplication rules allow it. Use suppress when another system owns buyer messaging.","enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Optional resource version last read by the caller.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"Void event timestamp.","format":"date-time","type":"string"},"reason":{"type":"string"}},"type":"object"},"VoidPackageResponse":{"properties":{"data":{"$ref":"#/components/schemas/VoidPackageResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"VoidPackageResult":{"properties":{"event":{"$ref":"#/components/schemas/FulfillmentEvent"},"fulfillment_notifications":{"items":{"$ref":"#/components/schemas/FulfillmentNotification"},"type":"array"},"package":{"$ref":"#/components/schemas/Package"},"unchanged":{"type":"boolean"}},"required":["package"],"type":"object"},"VoidShipmentRequest":{"properties":{"buyer_notification_behavior":{"description":"Controls buyer email handling. Omit or use send to send when recipient, template, and deduplication rules allow it. Use suppress when another system owns buyer messaging.","enum":["send","suppress"],"type":"string","x-enum-descriptions":["Send.","Suppress."],"x-flint-enum":"closed"},"expected_version":{"description":"Optional resource version last read by the caller.","format":"uint64","minimum":1,"type":"integer"},"occurred_at":{"description":"Void event timestamp.","format":"date-time","type":"string"},"reason":{"type":"string"}},"type":"object"},"VoidShipmentResponse":{"properties":{"data":{"$ref":"#/components/schemas/VoidShipmentResult"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"VoidShipmentResult":{"properties":{"events":{"items":{"$ref":"#/components/schemas/FulfillmentEvent"},"type":"array"},"fulfillment_notifications":{"items":{"$ref":"#/components/schemas/FulfillmentNotification"},"type":"array"},"packages":{"items":{"$ref":"#/components/schemas/Package"},"type":"array"},"shipment":{"$ref":"#/components/schemas/Shipment"},"unchanged":{"type":"boolean"}},"required":["shipment"],"type":"object"},"WaiveInvoiceLateFeeRequest":{"properties":{"reason":{"type":"string"}},"required":["reason"],"type":"object"},"WaiveReturnLineInspectionRequest":{"additionalProperties":false,"properties":{"expected_version":{"format":"int64","minimum":1,"type":"integer"},"reason":{"enum":["policy_override","trusted_in_store_handoff","merchant_review","other"],"type":"string","x-enum-descriptions":["Policy override.","Trusted in store handoff.","Merchant review.","Other."],"x-flint-enum":"closed"},"reason_message":{"type":"string"}},"required":["reason"],"type":"object"},"WaiveReturnLineInspectionResponse":{"properties":{"data":{"$ref":"#/components/schemas/Return"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"WebhookDelivery":{"properties":{"automatic_attempt_count":{"format":"int32","type":"integer"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"delivered_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"error_category":{"enum":["authentication","authorization","validation","server_error","rate_limit","idempotency","merchant_readiness","payment","request_error","webhook_timeout","webhook_dns","webhook_tls","webhook_connection","webhook_blocked_target","webhook_request","webhook_http_5xx","webhook_http_4xx","webhook_delivery"],"type":"string","x-enum-descriptions":["Authentication.","Authorization.","Validation.","Server error.","Rate limit.","Idempotency.","Merchant readiness.","Payment.","Request error.","Webhook timeout.","Webhook dns.","Webhook tls.","Webhook connection.","Webhook blocked target.","Webhook request.","Webhook http 5xx.","Webhook http 4xx.","Webhook delivery."],"x-flint-enum":"closed"},"error_summary":{"type":"string"},"last_error":{"type":"string"},"last_response_code":{"format":"int32","type":"integer"},"max_attempts":{"format":"int32","type":"integer"},"next_retry_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"recommended_action":{"type":"string"},"reference_url":{"type":"string"},"retryable":{"type":"boolean"},"status":{"enum":["pending","delivered","failed","suppressed"],"type":"string","x-enum-descriptions":["Pending.","Delivered.","Failed.","Suppressed."],"x-flint-enum":"open"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"webhook_delivery_id":{"type":"string"},"webhook_endpoint_id":{"type":"string"},"webhook_event_id":{"type":"string"}},"required":["automatic_attempt_count","created_at","max_attempts","status","updated_at","webhook_delivery_id","webhook_endpoint_id","webhook_event_id"],"type":"object"},"WebhookDeliveryAction":{"properties":{"attempt_number":{"format":"int32","type":"integer"},"attempt_status":{"enum":["queued","sending","delivered","failed"],"type":"string","x-enum-descriptions":["Queued.","Sending.","Delivered.","Failed."],"x-flint-enum":"open"},"completed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"delivery_status":{"enum":["pending","delivered","failed","suppressed"],"type":"string","x-enum-descriptions":["Pending.","Delivered.","Failed.","Suppressed."],"x-flint-enum":"open"},"delivery_trigger":{"enum":["automatic_delivery","automatic_retry","manual_resend","test_event"],"type":"string","x-enum-descriptions":["Automatic delivery.","Automatic retry.","Manual resend.","Test event."],"x-flint-enum":"closed"},"diagnostic_category":{"enum":["timeout","dns_error","tls_error","connection_error","blocked_target","request_error","http_error"],"type":"string","x-enum-descriptions":["Timeout.","Dns error.","Tls error.","Connection error.","Blocked target.","Request error.","Http error."],"x-flint-enum":"closed"},"duration_milliseconds":{"format":"int64","type":"integer"},"error_category":{"enum":["authentication","authorization","validation","server_error","rate_limit","idempotency","merchant_readiness","payment","request_error","webhook_timeout","webhook_dns","webhook_tls","webhook_connection","webhook_blocked_target","webhook_request","webhook_http_5xx","webhook_http_4xx","webhook_delivery"],"type":"string","x-enum-descriptions":["Authentication.","Authorization.","Validation.","Server error.","Rate limit.","Idempotency.","Merchant readiness.","Payment.","Request error.","Webhook timeout.","Webhook dns.","Webhook tls.","Webhook connection.","Webhook blocked target.","Webhook request.","Webhook http 5xx.","Webhook http 4xx.","Webhook delivery."],"x-flint-enum":"closed"},"error_message":{"type":"string"},"error_summary":{"type":"string"},"reason":{"type":"string"},"recommended_action":{"type":"string"},"reference_url":{"type":"string"},"response_body_excerpt":{"type":"string"},"response_content_type":{"type":"string"},"response_headers":{"type":"string"},"retryable":{"type":"boolean"},"started_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"status_code":{"format":"int32","type":"integer"},"webhook_delivery_attempt_id":{"type":"string"},"webhook_delivery_id":{"type":"string"},"webhook_event_id":{"type":"string"}},"required":["attempt_number","attempt_status","delivery_status","delivery_trigger","webhook_delivery_attempt_id","webhook_delivery_id","webhook_event_id"],"type":"object"},"WebhookDeliveryActionResponse":{"properties":{"data":{"$ref":"#/components/schemas/WebhookDeliveryAction"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"WebhookDeliveryAttempt":{"properties":{"api_version":{"description":"API version used for this delivery attempt. Omitted when the version was not recorded or payload rendering failed.","format":"date","type":"string"},"attempt_number":{"format":"int32","type":"integer"},"completed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"delivery_trigger":{"enum":["automatic_delivery","automatic_retry","manual_resend","test_event"],"type":"string","x-enum-descriptions":["Automatic delivery.","Automatic retry.","Manual resend.","Test event."],"x-flint-enum":"closed"},"diagnostic_category":{"enum":["timeout","dns_error","tls_error","connection_error","blocked_target","request_error","http_error"],"type":"string","x-enum-descriptions":["Timeout.","Dns error.","Tls error.","Connection error.","Blocked target.","Request error.","Http error."],"x-flint-enum":"closed"},"duration_milliseconds":{"format":"int64","type":"integer"},"error_category":{"enum":["authentication","authorization","validation","server_error","rate_limit","idempotency","merchant_readiness","payment","request_error","webhook_timeout","webhook_dns","webhook_tls","webhook_connection","webhook_blocked_target","webhook_request","webhook_http_5xx","webhook_http_4xx","webhook_delivery"],"type":"string","x-enum-descriptions":["Authentication.","Authorization.","Validation.","Server error.","Rate limit.","Idempotency.","Merchant readiness.","Payment.","Request error.","Webhook timeout.","Webhook dns.","Webhook tls.","Webhook connection.","Webhook blocked target.","Webhook request.","Webhook http 5xx.","Webhook http 4xx.","Webhook delivery."],"x-flint-enum":"closed"},"error_message":{"type":"string"},"error_summary":{"type":"string"},"reason":{"type":"string"},"recommended_action":{"type":"string"},"reference_url":{"type":"string"},"response_body_excerpt":{"type":"string"},"response_content_type":{"type":"string"},"response_headers":{"type":"string"},"retryable":{"type":"boolean"},"started_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"status":{"enum":["queued","sending","delivered","failed"],"type":"string","x-enum-descriptions":["Queued.","Sending.","Delivered.","Failed."],"x-flint-enum":"open"},"status_code":{"format":"int32","type":"integer"},"webhook_delivery_attempt_id":{"type":"string"},"webhook_delivery_id":{"type":"string"},"webhook_event_id":{"type":"string"}},"required":["attempt_number","delivery_trigger","status","webhook_delivery_attempt_id","webhook_delivery_id","webhook_event_id"],"type":"object"},"WebhookDeliveryAttemptListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WebhookDeliveryAttempt"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"WebhookDeliveryListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WebhookDelivery"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"WebhookDeliveryResponse":{"properties":{"data":{"$ref":"#/components/schemas/WebhookDelivery"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"WebhookEndpoint":{"properties":{"api_version":{"description":"A dated API version pins this endpoint. The value default follows the endpoint owner's merchant default at delivery time, including retries. Deliveries never use a newer version than the event's recorded version.","type":"string"},"api_version_changed_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"api_version_previous":{"readOnly":true,"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"description":{"type":"string"},"enabled":{"type":"boolean"},"enabled_events":{"description":"Event types this endpoint receives. Empty means all merchant-owned events. For partner_app sources, empty defaults to all app lifecycle events. For installed_merchants sources, provide at least one installed-merchant event.","items":{"type":"string"},"type":"array"},"event_sources":{"description":"Event sources this endpoint receives. Defaults to merchant. Use partner_app for app lifecycle events and installed_merchants for events from merchants that installed the partner app.","items":{"enum":["merchant","partner_app","installed_merchants"],"type":"string","x-enum-descriptions":["Merchant.","Partner app.","Installed merchants."],"x-flint-enum":"closed"},"type":"array"},"mode":{"description":"Partner-source delivery mode. Valid values are test, live, and both. Mode applies to installed_merchants events; partner_app lifecycle events require both.","enum":["test","live","both"],"type":"string","x-enum-descriptions":["Test.","Live.","Both."],"x-flint-enum":"closed"},"partner_app_id":{"description":"Partner app that owns partner_app or installed_merchants event sources.","type":"string"},"secret":{"readOnly":true,"type":"string"},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"url":{"type":"string"},"webhook_endpoint_id":{"readOnly":true,"type":"string"}},"required":["api_version","enabled","enabled_events","url","webhook_endpoint_id"],"type":"object"},"WebhookEndpointListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WebhookEndpoint"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"WebhookEndpointResponse":{"properties":{"data":{"$ref":"#/components/schemas/WebhookEndpoint"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"WebhookEvent":{"properties":{"api_request_log_id":{"type":"string"},"correlation_id":{"type":"string"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"event_origin":{"enum":["business_event","test_api"],"type":"string","x-enum-descriptions":["Business event.","Test api."],"x-flint-enum":"closed"},"event_source":{"enum":["merchant","partner_app","installed_merchants"],"type":"string","x-enum-descriptions":["Merchant.","Partner app.","Installed merchants."],"x-flint-enum":"closed"},"event_type":{"enum":["balance.updated","balance_transaction.created","balance_transaction.updated","capability.updated","checkout_session.closed","checkout_session.completed","checkout_session.expired","checkout_session.invalidated","credit_note.allocation_created","credit_note.allocation_reversed","credit_note.created","credit_note.issued","credit_note.updated","credit_note.voided","customer.created","customer.deletion_completed","customer.deletion_rejected","customer.deletion_requested","customer.updated","delivery_location_set.activated","delivery_location_set.archived","delivery_location_set.created","delivery_location_set.deactivated","delivery_location_set.updated","delivery_method.activated","delivery_method.archived","delivery_method.created","delivery_method.deactivated","delivery_method.updated","delivery_profile.activated","delivery_profile.archived","delivery_profile.created","delivery_profile.deactivated","delivery_profile.updated","delivery_rate.archived","delivery_rate.created","delivery_rate.updated","delivery_rate_callback.activated","delivery_rate_callback.archived","delivery_rate_callback.created","delivery_rate_callback.deactivated","delivery_rate_callback.updated","delivery_revocation.created","delivery_selection.committed","delivery_zone.activated","delivery_zone.archived","delivery_zone.created","delivery_zone.deactivated","delivery_zone.updated","dispute.closed","dispute.created","dispute.lost","dispute.needs_response","dispute.prevented","dispute.updated","dispute.warning_closed","dispute.won","fraud_warning.created","fraud_warning.updated","inventory.action_required","inventory.count.applied","inventory.level.updated","inventory.receipt.created","inventory.reservation.at_risk","inventory.reservation.closed","inventory.reservation.committed","inventory.reservation.consumed","inventory.reservation.created","inventory.reservation.hold_expired","inventory.reservation.released","inventory.shortage.detected","inventory.transfer.closed","inventory.transfer.departed","inventory.transfer.lost","inventory.transfer.received","inventory.transfer.returned","invoice.collection_block_resolved","invoice.collection_blocked","invoice.created","invoice.credited","invoice.delivery_failed","invoice.delivery_succeeded","invoice.issue_failed","invoice.issued","invoice.late_fee_assessed","invoice.late_fee_due","invoice.late_fee_waived","invoice.manual_payment_recorded","invoice.manual_payment_reversed","invoice.marked_uncollectible","invoice.overdue","invoice.paid","invoice.partially_paid","invoice.partially_refunded","invoice.payment_attempt_canceled","invoice.payment_attempt_expired","invoice.payment_failed","invoice.payment_processing","invoice.refunded","invoice.reminder_due","invoice.sent","invoice.updated","invoice.voided","merchant.readiness.updated","merchant_billing_balance.updated","merchant_subscription_invoice.issued","merchant_subscription_invoice.updated","order.closed","order.created","order.fulfillment.completed","order.fulfillment.created","order.fulfillment.event.created","order.fulfillment.package.created","order.fulfillment.package.updated","order.fulfillment.shipment.created","order.fulfillment.shipment.updated","order.fulfillment.status_changed","order.fulfillment.updated","order.inventory_action_required","order.inventory_exception.created","order.inventory_exception.resolved","order.paid","order.partially_paid","order.payment_authorization_canceled","order.payment_authorization_expired","order.payment_authorized","order.payment_captured","order.refunded","order.updated","partner_app.install.created","partner_app.install.environment_grant.created","partner_app.install.environment_grant.revoked","partner_app.install.permissions_updated","partner_app.install.revoked","partner_app.install.updated","payment_intent.canceled","payment_intent.fulfillment_hold.updated","payment_intent.payment_failed","payment_intent.processing","payment_intent.requires_action","payment_intent.requires_capture","payment_intent.succeeded","payment_method.failed","payment_method.removed","payment_method.saved","payout.canceled","payout.created","payout.failed","payout.paid","payout.reversed","payout.updated","payout_destination.created","payout_destination.deleted","payout_destination.disabled","payout_destination.updated","payout_settings.updated","refund.created","refund.failed","refund.updated","report.failed","report.succeeded","return.canceled","return.completed","return.created","return.decision_recorded","return.reopened","return.updated","return_disposition.created","return_disposition.updated","return_inspection.acceptance_decided","return_inspection.created","return_inspection.superseded","return_receipt.created","return_receipt.superseded","return_receipt.verified","return_resolution.created","return_resolution.updated","review.closed","review.opened","subscription.activated","subscription.canceled","subscription.created","subscription.dunning_exhausted","subscription.past_due","subscription.paused","subscription.payment_failed","subscription.payment_succeeded","subscription.renewal_upcoming","subscription.resumed","subscription.trial_ending","subscription.updated"],"type":"string","x-enum-descriptions":["Balance.updated.","Balance transaction.created.","Balance transaction.updated.","Capability.updated.","Checkout session.closed.","Checkout session.completed.","Checkout session.expired.","Checkout session.invalidated.","Credit note.allocation created.","Credit note.allocation reversed.","Credit note.created.","Credit note.issued.","Credit note.updated.","Credit note.voided.","Customer.created.","Customer.deletion completed.","Customer.deletion rejected.","Customer.deletion requested.","Customer.updated.","Delivery location set.activated.","Delivery location set.archived.","Delivery location set.created.","Delivery location set.deactivated.","Delivery location set.updated.","Delivery method.activated.","Delivery method.archived.","Delivery method.created.","Delivery method.deactivated.","Delivery method.updated.","Delivery profile.activated.","Delivery profile.archived.","Delivery profile.created.","Delivery profile.deactivated.","Delivery profile.updated.","Delivery rate.archived.","Delivery rate.created.","Delivery rate.updated.","Delivery rate callback.activated.","Delivery rate callback.archived.","Delivery rate callback.created.","Delivery rate callback.deactivated.","Delivery rate callback.updated.","Delivery revocation.created.","Delivery selection.committed.","Delivery zone.activated.","Delivery zone.archived.","Delivery zone.created.","Delivery zone.deactivated.","Delivery zone.updated.","Dispute.closed.","Dispute.created.","Dispute.lost.","Dispute.needs response.","Dispute.prevented.","Dispute.updated.","Dispute.warning closed.","Dispute.won.","Fraud warning.created.","Fraud warning.updated.","Inventory.action required.","Inventory.count.applied.","Inventory.level.updated.","Inventory.receipt.created.","Inventory.reservation.at risk.","Inventory.reservation.closed.","Inventory.reservation.committed.","Inventory.reservation.consumed.","Inventory.reservation.created.","Inventory.reservation.hold expired.","Inventory.reservation.released.","Inventory.shortage.detected.","Inventory.transfer.closed.","Inventory.transfer.departed.","Inventory.transfer.lost.","Inventory.transfer.received.","Inventory.transfer.returned.","Invoice.collection block resolved.","Invoice.collection blocked.","Invoice.created.","Invoice.credited.","Invoice.delivery failed.","Invoice.delivery succeeded.","Invoice.issue failed.","Invoice.issued.","Invoice.late fee assessed.","Invoice.late fee due.","Invoice.late fee waived.","Invoice.manual payment recorded.","Invoice.manual payment reversed.","Invoice.marked uncollectible.","Invoice.overdue.","Invoice.paid.","Invoice.partially paid.","Invoice.partially refunded.","Invoice.payment attempt canceled.","Invoice.payment attempt expired.","Invoice.payment failed.","Invoice.payment processing.","Invoice.refunded.","Invoice.reminder due.","Invoice.sent.","Invoice.updated.","Invoice.voided.","Merchant.readiness.updated.","Merchant billing balance.updated.","Merchant subscription invoice.issued.","Merchant subscription invoice.updated.","Order.closed.","Order.created.","Order.fulfillment.completed.","Order.fulfillment.created.","Order.fulfillment.event.created.","Order.fulfillment.package.created.","Order.fulfillment.package.updated.","Order.fulfillment.shipment.created.","Order.fulfillment.shipment.updated.","Order.fulfillment.status changed.","Order.fulfillment.updated.","Order.inventory action required.","Order.inventory exception.created.","Order.inventory exception.resolved.","Order.paid.","Order.partially paid.","Order.payment authorization canceled.","Order.payment authorization expired.","Order.payment authorized.","Order.payment captured.","Order.refunded.","Order.updated.","Partner app.install.created.","Partner app.install.environment grant.created.","Partner app.install.environment grant.revoked.","Partner app.install.permissions updated.","Partner app.install.revoked.","Partner app.install.updated.","Payment intent.canceled.","Payment intent.fulfillment hold.updated.","Payment intent.payment failed.","Payment intent.processing.","Payment intent.requires action.","Payment intent.requires capture.","Payment intent.succeeded.","Payment method.failed.","Payment method.removed.","Payment method.saved.","Payout.canceled.","Payout.created.","Payout.failed.","Payout.paid.","Payout.reversed.","Payout.updated.","Payout destination.created.","Payout destination.deleted.","Payout destination.disabled.","Payout destination.updated.","Payout settings.updated.","Refund.created.","Refund.failed.","Refund.updated.","Report.failed.","Report.succeeded.","Return.canceled.","Return.completed.","Return.created.","Return.decision recorded.","Return.reopened.","Return.updated.","Return disposition.created.","Return disposition.updated.","Return inspection.acceptance decided.","Return inspection.created.","Return inspection.superseded.","Return receipt.created.","Return receipt.superseded.","Return receipt.verified.","Return resolution.created.","Return resolution.updated.","Review.closed.","Review.opened.","Subscription.activated.","Subscription.canceled.","Subscription.created.","Subscription.dunning exhausted.","Subscription.past due.","Subscription.paused.","Subscription.payment failed.","Subscription.payment succeeded.","Subscription.renewal upcoming.","Subscription.resumed.","Subscription.trial ending.","Subscription.updated."],"x-flint-enum":"closed"},"partner_app_id":{"type":"string"},"payload":{"additionalProperties":true,"description":"Stored webhook delivery payload as structured JSON. Omitted from list responses and from detail responses when the caller lacks read access to the attributed resource or the payload has expired.","type":"object"},"request_id":{"type":"string"},"resource_id":{"type":"string"},"resource_type":{"enum":["balance","balance_transaction","capability","checkout_session","customer","dispute","fraud_warning","invoice","merchant","inventory_count","inventory_level","inventory_reservation","inventory_reservation_line","inventory_receipt","inventory_transfer","order","payment_intent","payment_method","payout","payout_destination","payout_settings","refund","return","return_disposition","return_inspection","return_receipt","return_resolution","review","subscription"],"type":"string","x-enum-descriptions":["Balance.","Balance transaction.","Capability.","Checkout session.","Customer.","Dispute.","Fraud warning.","Invoice.","Merchant.","Inventory count.","Inventory level.","Inventory reservation.","Inventory reservation line.","Inventory receipt.","Inventory transfer.","Order.","Payment intent.","Payment method.","Payout.","Payout destination.","Payout settings.","Refund.","Return.","Return disposition.","Return inspection.","Return receipt.","Return resolution.","Review.","Subscription."],"x-flint-enum":"closed"},"test":{"type":"boolean"},"webhook_event_id":{"type":"string"}},"required":["created_at","event_origin","event_type","test","webhook_event_id"],"type":"object"},"WebhookEventListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WebhookEvent"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"WebhookEventResponse":{"properties":{"data":{"$ref":"#/components/schemas/WebhookEvent"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"WebhookEventType":{"properties":{"description":{"description":"Concise semantics for the state transition or event occurrence.","type":"string"},"event_sources":{"description":"Event source buckets where this event type is valid.","items":{"enum":["merchant","partner_app","installed_merchants"],"type":"string","x-enum-descriptions":["Merchant.","Partner app.","Installed merchants."],"x-flint-enum":"closed"},"type":"array"},"event_type":{"description":"Webhook event type string accepted by compatible endpoint enabled_events values and webhook event filters.","enum":["balance.updated","balance_transaction.created","balance_transaction.updated","capability.updated","checkout_session.closed","checkout_session.completed","checkout_session.expired","checkout_session.invalidated","credit_note.allocation_created","credit_note.allocation_reversed","credit_note.created","credit_note.issued","credit_note.updated","credit_note.voided","customer.created","customer.deletion_completed","customer.deletion_rejected","customer.deletion_requested","customer.updated","delivery_location_set.activated","delivery_location_set.archived","delivery_location_set.created","delivery_location_set.deactivated","delivery_location_set.updated","delivery_method.activated","delivery_method.archived","delivery_method.created","delivery_method.deactivated","delivery_method.updated","delivery_profile.activated","delivery_profile.archived","delivery_profile.created","delivery_profile.deactivated","delivery_profile.updated","delivery_rate.archived","delivery_rate.created","delivery_rate.updated","delivery_rate_callback.activated","delivery_rate_callback.archived","delivery_rate_callback.created","delivery_rate_callback.deactivated","delivery_rate_callback.updated","delivery_revocation.created","delivery_selection.committed","delivery_zone.activated","delivery_zone.archived","delivery_zone.created","delivery_zone.deactivated","delivery_zone.updated","dispute.closed","dispute.created","dispute.lost","dispute.needs_response","dispute.prevented","dispute.updated","dispute.warning_closed","dispute.won","fraud_warning.created","fraud_warning.updated","inventory.action_required","inventory.count.applied","inventory.level.updated","inventory.receipt.created","inventory.reservation.at_risk","inventory.reservation.closed","inventory.reservation.committed","inventory.reservation.consumed","inventory.reservation.created","inventory.reservation.hold_expired","inventory.reservation.released","inventory.shortage.detected","inventory.transfer.closed","inventory.transfer.departed","inventory.transfer.lost","inventory.transfer.received","inventory.transfer.returned","invoice.collection_block_resolved","invoice.collection_blocked","invoice.created","invoice.credited","invoice.delivery_failed","invoice.delivery_succeeded","invoice.issue_failed","invoice.issued","invoice.late_fee_assessed","invoice.late_fee_due","invoice.late_fee_waived","invoice.manual_payment_recorded","invoice.manual_payment_reversed","invoice.marked_uncollectible","invoice.overdue","invoice.paid","invoice.partially_paid","invoice.partially_refunded","invoice.payment_attempt_canceled","invoice.payment_attempt_expired","invoice.payment_failed","invoice.payment_processing","invoice.refunded","invoice.reminder_due","invoice.sent","invoice.updated","invoice.voided","merchant.readiness.updated","merchant_billing_balance.updated","merchant_subscription_invoice.issued","merchant_subscription_invoice.updated","order.closed","order.created","order.fulfillment.completed","order.fulfillment.created","order.fulfillment.event.created","order.fulfillment.package.created","order.fulfillment.package.updated","order.fulfillment.shipment.created","order.fulfillment.shipment.updated","order.fulfillment.status_changed","order.fulfillment.updated","order.inventory_action_required","order.inventory_exception.created","order.inventory_exception.resolved","order.paid","order.partially_paid","order.payment_authorization_canceled","order.payment_authorization_expired","order.payment_authorized","order.payment_captured","order.refunded","order.updated","partner_app.install.created","partner_app.install.environment_grant.created","partner_app.install.environment_grant.revoked","partner_app.install.permissions_updated","partner_app.install.revoked","partner_app.install.updated","payment_intent.canceled","payment_intent.fulfillment_hold.updated","payment_intent.payment_failed","payment_intent.processing","payment_intent.requires_action","payment_intent.requires_capture","payment_intent.succeeded","payment_method.failed","payment_method.removed","payment_method.saved","payout.canceled","payout.created","payout.failed","payout.paid","payout.reversed","payout.updated","payout_destination.created","payout_destination.deleted","payout_destination.disabled","payout_destination.updated","payout_settings.updated","refund.created","refund.failed","refund.updated","report.failed","report.succeeded","return.canceled","return.completed","return.created","return.decision_recorded","return.reopened","return.updated","return_disposition.created","return_disposition.updated","return_inspection.acceptance_decided","return_inspection.created","return_inspection.superseded","return_receipt.created","return_receipt.superseded","return_receipt.verified","return_resolution.created","return_resolution.updated","review.closed","review.opened","subscription.activated","subscription.canceled","subscription.created","subscription.dunning_exhausted","subscription.past_due","subscription.paused","subscription.payment_failed","subscription.payment_succeeded","subscription.renewal_upcoming","subscription.resumed","subscription.trial_ending","subscription.updated"],"type":"string","x-enum-descriptions":["Balance.updated.","Balance transaction.created.","Balance transaction.updated.","Capability.updated.","Checkout session.closed.","Checkout session.completed.","Checkout session.expired.","Checkout session.invalidated.","Credit note.allocation created.","Credit note.allocation reversed.","Credit note.created.","Credit note.issued.","Credit note.updated.","Credit note.voided.","Customer.created.","Customer.deletion completed.","Customer.deletion rejected.","Customer.deletion requested.","Customer.updated.","Delivery location set.activated.","Delivery location set.archived.","Delivery location set.created.","Delivery location set.deactivated.","Delivery location set.updated.","Delivery method.activated.","Delivery method.archived.","Delivery method.created.","Delivery method.deactivated.","Delivery method.updated.","Delivery profile.activated.","Delivery profile.archived.","Delivery profile.created.","Delivery profile.deactivated.","Delivery profile.updated.","Delivery rate.archived.","Delivery rate.created.","Delivery rate.updated.","Delivery rate callback.activated.","Delivery rate callback.archived.","Delivery rate callback.created.","Delivery rate callback.deactivated.","Delivery rate callback.updated.","Delivery revocation.created.","Delivery selection.committed.","Delivery zone.activated.","Delivery zone.archived.","Delivery zone.created.","Delivery zone.deactivated.","Delivery zone.updated.","Dispute.closed.","Dispute.created.","Dispute.lost.","Dispute.needs response.","Dispute.prevented.","Dispute.updated.","Dispute.warning closed.","Dispute.won.","Fraud warning.created.","Fraud warning.updated.","Inventory.action required.","Inventory.count.applied.","Inventory.level.updated.","Inventory.receipt.created.","Inventory.reservation.at risk.","Inventory.reservation.closed.","Inventory.reservation.committed.","Inventory.reservation.consumed.","Inventory.reservation.created.","Inventory.reservation.hold expired.","Inventory.reservation.released.","Inventory.shortage.detected.","Inventory.transfer.closed.","Inventory.transfer.departed.","Inventory.transfer.lost.","Inventory.transfer.received.","Inventory.transfer.returned.","Invoice.collection block resolved.","Invoice.collection blocked.","Invoice.created.","Invoice.credited.","Invoice.delivery failed.","Invoice.delivery succeeded.","Invoice.issue failed.","Invoice.issued.","Invoice.late fee assessed.","Invoice.late fee due.","Invoice.late fee waived.","Invoice.manual payment recorded.","Invoice.manual payment reversed.","Invoice.marked uncollectible.","Invoice.overdue.","Invoice.paid.","Invoice.partially paid.","Invoice.partially refunded.","Invoice.payment attempt canceled.","Invoice.payment attempt expired.","Invoice.payment failed.","Invoice.payment processing.","Invoice.refunded.","Invoice.reminder due.","Invoice.sent.","Invoice.updated.","Invoice.voided.","Merchant.readiness.updated.","Merchant billing balance.updated.","Merchant subscription invoice.issued.","Merchant subscription invoice.updated.","Order.closed.","Order.created.","Order.fulfillment.completed.","Order.fulfillment.created.","Order.fulfillment.event.created.","Order.fulfillment.package.created.","Order.fulfillment.package.updated.","Order.fulfillment.shipment.created.","Order.fulfillment.shipment.updated.","Order.fulfillment.status changed.","Order.fulfillment.updated.","Order.inventory action required.","Order.inventory exception.created.","Order.inventory exception.resolved.","Order.paid.","Order.partially paid.","Order.payment authorization canceled.","Order.payment authorization expired.","Order.payment authorized.","Order.payment captured.","Order.refunded.","Order.updated.","Partner app.install.created.","Partner app.install.environment grant.created.","Partner app.install.environment grant.revoked.","Partner app.install.permissions updated.","Partner app.install.revoked.","Partner app.install.updated.","Payment intent.canceled.","Payment intent.fulfillment hold.updated.","Payment intent.payment failed.","Payment intent.processing.","Payment intent.requires action.","Payment intent.requires capture.","Payment intent.succeeded.","Payment method.failed.","Payment method.removed.","Payment method.saved.","Payout.canceled.","Payout.created.","Payout.failed.","Payout.paid.","Payout.reversed.","Payout.updated.","Payout destination.created.","Payout destination.deleted.","Payout destination.disabled.","Payout destination.updated.","Payout settings.updated.","Refund.created.","Refund.failed.","Refund.updated.","Report.failed.","Report.succeeded.","Return.canceled.","Return.completed.","Return.created.","Return.decision recorded.","Return.reopened.","Return.updated.","Return disposition.created.","Return disposition.updated.","Return inspection.acceptance decided.","Return inspection.created.","Return inspection.superseded.","Return receipt.created.","Return receipt.superseded.","Return receipt.verified.","Return resolution.created.","Return resolution.updated.","Review.closed.","Review.opened.","Subscription.activated.","Subscription.canceled.","Subscription.created.","Subscription.dunning exhausted.","Subscription.past due.","Subscription.paused.","Subscription.payment failed.","Subscription.payment succeeded.","Subscription.renewal upcoming.","Subscription.resumed.","Subscription.trial ending.","Subscription.updated."],"x-flint-enum":"closed"}},"required":["description","event_sources","event_type"],"type":"object"},"WebhookEventTypeListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WebhookEventType"},"type":"array"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"next_page_token":{"type":"string"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"WebhookSecret":{"properties":{"secret":{"type":"string"}},"required":["secret"],"type":"object"},"WebhookSecretRotationResponse":{"properties":{"data":{"$ref":"#/components/schemas/WebhookSecret"},"meta":{"$ref":"#/components/schemas/ResponseMeta"},"request_id":{"type":"string"}},"required":["data"],"type":"object"},"WebhookStreamDisconnect":{"properties":{"reason":{"enum":["ttl","authorization_changed","server_error"],"type":"string","x-enum-descriptions":["Ttl.","Authorization changed.","Server error."],"x-flint-enum":"closed"}},"required":["reason"],"type":"object"},"WebhookStreamGap":{"properties":{"reason":{"enum":["cursor_unavailable","payload_expired","backpressure"],"type":"string","x-enum-descriptions":["Cursor unavailable.","Payload expired.","Backpressure."],"x-flint-enum":"closed"},"requested_cursor":{"type":"string"},"resume_cursor":{"type":"string"}},"required":["reason"],"type":"object"},"WebhookStreamReady":{"properties":{"cursor":{"type":"string"}},"type":"object"},"WebhookStreamWithheld":{"properties":{"event_type":{"enum":["balance.updated","balance_transaction.created","balance_transaction.updated","capability.updated","checkout_session.closed","checkout_session.completed","checkout_session.expired","checkout_session.invalidated","credit_note.allocation_created","credit_note.allocation_reversed","credit_note.created","credit_note.issued","credit_note.updated","credit_note.voided","customer.created","customer.deletion_completed","customer.deletion_rejected","customer.deletion_requested","customer.updated","delivery_location_set.activated","delivery_location_set.archived","delivery_location_set.created","delivery_location_set.deactivated","delivery_location_set.updated","delivery_method.activated","delivery_method.archived","delivery_method.created","delivery_method.deactivated","delivery_method.updated","delivery_profile.activated","delivery_profile.archived","delivery_profile.created","delivery_profile.deactivated","delivery_profile.updated","delivery_rate.archived","delivery_rate.created","delivery_rate.updated","delivery_rate_callback.activated","delivery_rate_callback.archived","delivery_rate_callback.created","delivery_rate_callback.deactivated","delivery_rate_callback.updated","delivery_revocation.created","delivery_selection.committed","delivery_zone.activated","delivery_zone.archived","delivery_zone.created","delivery_zone.deactivated","delivery_zone.updated","dispute.closed","dispute.created","dispute.lost","dispute.needs_response","dispute.prevented","dispute.updated","dispute.warning_closed","dispute.won","fraud_warning.created","fraud_warning.updated","inventory.action_required","inventory.count.applied","inventory.level.updated","inventory.receipt.created","inventory.reservation.at_risk","inventory.reservation.closed","inventory.reservation.committed","inventory.reservation.consumed","inventory.reservation.created","inventory.reservation.hold_expired","inventory.reservation.released","inventory.shortage.detected","inventory.transfer.closed","inventory.transfer.departed","inventory.transfer.lost","inventory.transfer.received","inventory.transfer.returned","invoice.collection_block_resolved","invoice.collection_blocked","invoice.created","invoice.credited","invoice.delivery_failed","invoice.delivery_succeeded","invoice.issue_failed","invoice.issued","invoice.late_fee_assessed","invoice.late_fee_due","invoice.late_fee_waived","invoice.manual_payment_recorded","invoice.manual_payment_reversed","invoice.marked_uncollectible","invoice.overdue","invoice.paid","invoice.partially_paid","invoice.partially_refunded","invoice.payment_attempt_canceled","invoice.payment_attempt_expired","invoice.payment_failed","invoice.payment_processing","invoice.refunded","invoice.reminder_due","invoice.sent","invoice.updated","invoice.voided","merchant.readiness.updated","merchant_billing_balance.updated","merchant_subscription_invoice.issued","merchant_subscription_invoice.updated","order.closed","order.created","order.fulfillment.completed","order.fulfillment.created","order.fulfillment.event.created","order.fulfillment.package.created","order.fulfillment.package.updated","order.fulfillment.shipment.created","order.fulfillment.shipment.updated","order.fulfillment.status_changed","order.fulfillment.updated","order.inventory_action_required","order.inventory_exception.created","order.inventory_exception.resolved","order.paid","order.partially_paid","order.payment_authorization_canceled","order.payment_authorization_expired","order.payment_authorized","order.payment_captured","order.refunded","order.updated","partner_app.install.created","partner_app.install.environment_grant.created","partner_app.install.environment_grant.revoked","partner_app.install.permissions_updated","partner_app.install.revoked","partner_app.install.updated","payment_intent.canceled","payment_intent.fulfillment_hold.updated","payment_intent.payment_failed","payment_intent.processing","payment_intent.requires_action","payment_intent.requires_capture","payment_intent.succeeded","payment_method.failed","payment_method.removed","payment_method.saved","payout.canceled","payout.created","payout.failed","payout.paid","payout.reversed","payout.updated","payout_destination.created","payout_destination.deleted","payout_destination.disabled","payout_destination.updated","payout_settings.updated","refund.created","refund.failed","refund.updated","report.failed","report.succeeded","return.canceled","return.completed","return.created","return.decision_recorded","return.reopened","return.updated","return_disposition.created","return_disposition.updated","return_inspection.acceptance_decided","return_inspection.created","return_inspection.superseded","return_receipt.created","return_receipt.superseded","return_receipt.verified","return_resolution.created","return_resolution.updated","review.closed","review.opened","subscription.activated","subscription.canceled","subscription.created","subscription.dunning_exhausted","subscription.past_due","subscription.paused","subscription.payment_failed","subscription.payment_succeeded","subscription.renewal_upcoming","subscription.resumed","subscription.trial_ending","subscription.updated"],"type":"string","x-enum-descriptions":["Balance.updated.","Balance transaction.created.","Balance transaction.updated.","Capability.updated.","Checkout session.closed.","Checkout session.completed.","Checkout session.expired.","Checkout session.invalidated.","Credit note.allocation created.","Credit note.allocation reversed.","Credit note.created.","Credit note.issued.","Credit note.updated.","Credit note.voided.","Customer.created.","Customer.deletion completed.","Customer.deletion rejected.","Customer.deletion requested.","Customer.updated.","Delivery location set.activated.","Delivery location set.archived.","Delivery location set.created.","Delivery location set.deactivated.","Delivery location set.updated.","Delivery method.activated.","Delivery method.archived.","Delivery method.created.","Delivery method.deactivated.","Delivery method.updated.","Delivery profile.activated.","Delivery profile.archived.","Delivery profile.created.","Delivery profile.deactivated.","Delivery profile.updated.","Delivery rate.archived.","Delivery rate.created.","Delivery rate.updated.","Delivery rate callback.activated.","Delivery rate callback.archived.","Delivery rate callback.created.","Delivery rate callback.deactivated.","Delivery rate callback.updated.","Delivery revocation.created.","Delivery selection.committed.","Delivery zone.activated.","Delivery zone.archived.","Delivery zone.created.","Delivery zone.deactivated.","Delivery zone.updated.","Dispute.closed.","Dispute.created.","Dispute.lost.","Dispute.needs response.","Dispute.prevented.","Dispute.updated.","Dispute.warning closed.","Dispute.won.","Fraud warning.created.","Fraud warning.updated.","Inventory.action required.","Inventory.count.applied.","Inventory.level.updated.","Inventory.receipt.created.","Inventory.reservation.at risk.","Inventory.reservation.closed.","Inventory.reservation.committed.","Inventory.reservation.consumed.","Inventory.reservation.created.","Inventory.reservation.hold expired.","Inventory.reservation.released.","Inventory.shortage.detected.","Inventory.transfer.closed.","Inventory.transfer.departed.","Inventory.transfer.lost.","Inventory.transfer.received.","Inventory.transfer.returned.","Invoice.collection block resolved.","Invoice.collection blocked.","Invoice.created.","Invoice.credited.","Invoice.delivery failed.","Invoice.delivery succeeded.","Invoice.issue failed.","Invoice.issued.","Invoice.late fee assessed.","Invoice.late fee due.","Invoice.late fee waived.","Invoice.manual payment recorded.","Invoice.manual payment reversed.","Invoice.marked uncollectible.","Invoice.overdue.","Invoice.paid.","Invoice.partially paid.","Invoice.partially refunded.","Invoice.payment attempt canceled.","Invoice.payment attempt expired.","Invoice.payment failed.","Invoice.payment processing.","Invoice.refunded.","Invoice.reminder due.","Invoice.sent.","Invoice.updated.","Invoice.voided.","Merchant.readiness.updated.","Merchant billing balance.updated.","Merchant subscription invoice.issued.","Merchant subscription invoice.updated.","Order.closed.","Order.created.","Order.fulfillment.completed.","Order.fulfillment.created.","Order.fulfillment.event.created.","Order.fulfillment.package.created.","Order.fulfillment.package.updated.","Order.fulfillment.shipment.created.","Order.fulfillment.shipment.updated.","Order.fulfillment.status changed.","Order.fulfillment.updated.","Order.inventory action required.","Order.inventory exception.created.","Order.inventory exception.resolved.","Order.paid.","Order.partially paid.","Order.payment authorization canceled.","Order.payment authorization expired.","Order.payment authorized.","Order.payment captured.","Order.refunded.","Order.updated.","Partner app.install.created.","Partner app.install.environment grant.created.","Partner app.install.environment grant.revoked.","Partner app.install.permissions updated.","Partner app.install.revoked.","Partner app.install.updated.","Payment intent.canceled.","Payment intent.fulfillment hold.updated.","Payment intent.payment failed.","Payment intent.processing.","Payment intent.requires action.","Payment intent.requires capture.","Payment intent.succeeded.","Payment method.failed.","Payment method.removed.","Payment method.saved.","Payout.canceled.","Payout.created.","Payout.failed.","Payout.paid.","Payout.reversed.","Payout.updated.","Payout destination.created.","Payout destination.deleted.","Payout destination.disabled.","Payout destination.updated.","Payout settings.updated.","Refund.created.","Refund.failed.","Refund.updated.","Report.failed.","Report.succeeded.","Return.canceled.","Return.completed.","Return.created.","Return.decision recorded.","Return.reopened.","Return.updated.","Return disposition.created.","Return disposition.updated.","Return inspection.acceptance decided.","Return inspection.created.","Return inspection.superseded.","Return receipt.created.","Return receipt.superseded.","Return receipt.verified.","Return resolution.created.","Return resolution.updated.","Review.closed.","Review.opened.","Subscription.activated.","Subscription.canceled.","Subscription.created.","Subscription.dunning exhausted.","Subscription.past due.","Subscription.paused.","Subscription.payment failed.","Subscription.payment succeeded.","Subscription.renewal upcoming.","Subscription.resumed.","Subscription.trial ending.","Subscription.updated."],"x-flint-enum":"closed"},"reason":{"enum":["missing_resource_scope","resource_unattributed"],"type":"string","x-enum-descriptions":["Missing resource scope.","Resource unattributed."],"x-flint-enum":"closed"},"required_scopes":{"items":{"type":"string"},"type":"array"},"resource_type":{"enum":["balance","balance_transaction","capability","checkout_session","customer","dispute","fraud_warning","invoice","merchant","inventory_count","inventory_level","inventory_reservation","inventory_reservation_line","inventory_receipt","inventory_transfer","order","payment_intent","payment_method","payout","payout_destination","payout_settings","refund","return","return_disposition","return_inspection","return_receipt","return_resolution","review","subscription"],"type":"string","x-enum-descriptions":["Balance.","Balance transaction.","Capability.","Checkout session.","Customer.","Dispute.","Fraud warning.","Invoice.","Merchant.","Inventory count.","Inventory level.","Inventory reservation.","Inventory reservation line.","Inventory receipt.","Inventory transfer.","Order.","Payment intent.","Payment method.","Payout.","Payout destination.","Payout settings.","Refund.","Return.","Return disposition.","Return inspection.","Return receipt.","Return resolution.","Review.","Subscription."],"x-flint-enum":"closed"},"webhook_event_id":{"type":"string"}},"required":["event_type","reason","webhook_event_id"],"type":"object"},"Webhook_balance_transaction_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/BalanceTransaction"},"event_type":{"const":"balance_transaction.created"}}},"Webhook_balance_transaction_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/BalanceTransaction"},"event_type":{"const":"balance_transaction.updated"}}},"Webhook_balance_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"balance_id":{"type":"string"}},"required":["balance_id"],"type":"object"},"event_type":{"const":"balance.updated"}}},"Webhook_capability_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"capability":{"type":"string"}},"required":["capability"],"type":"object"},"event_type":{"const":"capability.updated"}}},"Webhook_checkout_session_closed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"checkout_session_id":{"type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"expired_at":{"format":"date-time","type":"string"},"invoice_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"payment_link_id":{"type":"string"},"reason":{"enum":["api"],"type":"string","x-enum-descriptions":["Api."],"x-flint-enum":"closed"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["closed"],"type":"string","x-enum-descriptions":["Closed."],"x-flint-enum":"open"},"superseding_checkout_session_id":{"type":"string"}},"required":["checkout_session_id","status","reason","resource_updated_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"checkout_session.closed"}}},"Webhook_checkout_session_closed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"checkout_session_id":{"type":"string"},"expired_at":{"format":"date-time","type":"string"},"invoice_id":{"type":"string"},"order_id":{"type":"string"},"payment_link_id":{"type":"string"},"reason":{"enum":["api"],"type":"string","x-enum-descriptions":["Api."],"x-flint-enum":"closed"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["closed"],"type":"string","x-enum-descriptions":["Closed."],"x-flint-enum":"open"},"superseding_checkout_session_id":{"type":"string"}},"required":["checkout_session_id","status","reason","resource_updated_at"],"type":"object"},"event_type":{"const":"checkout_session.closed"}}},"Webhook_checkout_session_completed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"checkout_session_id":{"type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["checkout_session_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"checkout_session.completed"}}},"Webhook_checkout_session_completed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"checkout_session_id":{"type":"string"}},"required":["checkout_session_id"],"type":"object"},"event_type":{"const":"checkout_session.completed"}}},"Webhook_checkout_session_expired_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"checkout_session_id":{"type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"expired_at":{"format":"date-time","type":"string"},"invoice_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"payment_link_id":{"type":"string"},"reason":{"enum":["expired"],"type":"string","x-enum-descriptions":["Expired."],"x-flint-enum":"closed"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["expired"],"type":"string","x-enum-descriptions":["Expired."],"x-flint-enum":"open"},"superseding_checkout_session_id":{"type":"string"}},"required":["checkout_session_id","status","reason","resource_updated_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"checkout_session.expired"}}},"Webhook_checkout_session_expired_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"checkout_session_id":{"type":"string"},"expired_at":{"format":"date-time","type":"string"},"invoice_id":{"type":"string"},"order_id":{"type":"string"},"payment_link_id":{"type":"string"},"reason":{"enum":["expired"],"type":"string","x-enum-descriptions":["Expired."],"x-flint-enum":"closed"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["expired"],"type":"string","x-enum-descriptions":["Expired."],"x-flint-enum":"open"},"superseding_checkout_session_id":{"type":"string"}},"required":["checkout_session_id","status","reason","resource_updated_at"],"type":"object"},"event_type":{"const":"checkout_session.expired"}}},"Webhook_checkout_session_invalidated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"checkout_session_id":{"type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"expired_at":{"format":"date-time","type":"string"},"invoice_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"payment_link_id":{"type":"string"},"reason":{"enum":["order_mutated","superseded","invoice_paid_elsewhere","invoice_voided","invoice_uncollectible","invoice_balance_changed"],"type":"string","x-enum-descriptions":["Order mutated.","Superseded.","Invoice paid elsewhere.","Invoice voided.","Invoice uncollectible.","Invoice balance changed."],"x-flint-enum":"closed"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["invalidated"],"type":"string","x-enum-descriptions":["Invalidated."],"x-flint-enum":"open"},"superseding_checkout_session_id":{"type":"string"}},"required":["checkout_session_id","status","reason","resource_updated_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"checkout_session.invalidated"}}},"Webhook_checkout_session_invalidated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"checkout_session_id":{"type":"string"},"expired_at":{"format":"date-time","type":"string"},"invoice_id":{"type":"string"},"order_id":{"type":"string"},"payment_link_id":{"type":"string"},"reason":{"enum":["order_mutated","superseded","invoice_paid_elsewhere","invoice_voided","invoice_uncollectible","invoice_balance_changed"],"type":"string","x-enum-descriptions":["Order mutated.","Superseded.","Invoice paid elsewhere.","Invoice voided.","Invoice uncollectible.","Invoice balance changed."],"x-flint-enum":"closed"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["invalidated"],"type":"string","x-enum-descriptions":["Invalidated."],"x-flint-enum":"open"},"superseding_checkout_session_id":{"type":"string"}},"required":["checkout_session_id","status","reason","resource_updated_at"],"type":"object"},"event_type":{"const":"checkout_session.invalidated"}}},"Webhook_credit_note_allocation_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"description":"One application of credit to the invoice. Allocations are append-only: a reversal sets reversed_at rather than removing the row.","properties":{"allocated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"amount_money":{"$ref":"#/components/schemas/Money","description":"Credit applied to the invoice balance."},"credit_note_allocation_id":{"type":"string"},"credit_note_id":{"type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"idempotency_key":{"description":"The key the caller sent when allocating. It is this allocation's identity and is filterable on the allocations list.","type":"string"},"invoice_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"reversed_at":{"description":"When the allocation was reversed and its credit returned. Absent while the allocation stands.","format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"}},"required":["allocated_at","amount_money","credit_note_allocation_id","credit_note_id","idempotency_key","invoice_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"credit_note.allocation_created"}}},"Webhook_credit_note_allocation_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/CreditNoteAllocation"},"event_type":{"const":"credit_note.allocation_created"}}},"Webhook_credit_note_allocation_reversed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"description":"One application of credit to the invoice. Allocations are append-only: a reversal sets reversed_at rather than removing the row.","properties":{"allocated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"amount_money":{"$ref":"#/components/schemas/Money","description":"Credit applied to the invoice balance."},"credit_note_allocation_id":{"type":"string"},"credit_note_id":{"type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"idempotency_key":{"description":"The key the caller sent when allocating. It is this allocation's identity and is filterable on the allocations list.","type":"string"},"invoice_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"reversed_at":{"description":"When the allocation was reversed and its credit returned. Absent while the allocation stands.","format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"}},"required":["allocated_at","amount_money","credit_note_allocation_id","credit_note_id","idempotency_key","invoice_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"credit_note.allocation_reversed"}}},"Webhook_credit_note_allocation_reversed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/CreditNoteAllocation"},"event_type":{"const":"credit_note.allocation_reversed"}}},"Webhook_credit_note_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"description":"A correction against an issued invoice. Credit notes reduce what is owed; refunds return what was already collected.","properties":{"buyer_tax_identity":{"anyOf":[{"$ref":"#/components/schemas/TaxIdentity"},{"type":"null"}],"description":"Identity frozen on the source invoice at issue. Later profile edits do not change this document.","readOnly":true},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"credit_note_id":{"type":"string"},"credit_note_lines":{"items":{"$ref":"#/components/schemas/CreditNoteLine"},"type":"array"},"credit_note_number":{"description":"Assigned at issue and stable from then on. Absent while the credit note is a draft.","type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"external_reference_id":{"type":"string"},"invoice_id":{"type":"string"},"issued_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"latest_refund_status":{"enum":["pending","in_transit","succeeded","failed","requires_action","canceled","partially_succeeded"],"type":"string","x-enum-descriptions":["Pending.","In transit.","Succeeded.","Failed.","Requires action.","Canceled.","Partially succeeded."],"x-flint-enum":"open"},"memo":{"description":"Free text shown on the credit note, up to 4096 characters.","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"pending_refund_money":{"$ref":"#/components/schemas/Money"},"reason":{"description":"Why the invoice is being corrected. Shown on the credit note document.","enum":["returned_goods","order_adjustment","billing_error","goodwill","other"],"type":"string","x-enum-descriptions":["Returned goods.","Order adjustment.","Billing error.","Goodwill.","Other."],"x-flint-enum":"closed"},"refunded_money":{"$ref":"#/components/schemas/Money"},"seller_tax_identity":{"anyOf":[{"$ref":"#/components/schemas/TaxIdentity"},{"type":"null"}],"description":"Identity frozen on the source invoice at issue. Later profile edits do not change this document.","readOnly":true},"source_type":{"const":"installed_merchants"},"status":{"description":"draft while the credit note is editable, issued once it is numbered and frozen, void once retired.","enum":["draft","issued","void"],"type":"string","x-enum-descriptions":["Draft.","Issued.","Void."],"x-flint-enum":"open"},"total_money":{"$ref":"#/components/schemas/Money","description":"The face value of the credit note, the sum of its lines."},"unallocated_money":{"$ref":"#/components/schemas/Money","description":"Credit still available to allocate. Equals total_money at issue, falls as credit is applied, and rises again when an allocation is reversed."},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"version":{"description":"Current credit note version. Send this as expected_version when updating the draft.","format":"int64","minimum":1,"readOnly":true,"type":"integer"},"voided_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["created_at","credit_note_id","credit_note_lines","invoice_id","merchant_id","pending_refund_money","reason","refunded_money","status","total_money","unallocated_money","updated_at","version","source_type","mode","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"credit_note.created"}}},"Webhook_credit_note_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/CreditNote"},"event_type":{"const":"credit_note.created"}}},"Webhook_credit_note_issued_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"description":"A correction against an issued invoice. Credit notes reduce what is owed; refunds return what was already collected.","properties":{"buyer_tax_identity":{"anyOf":[{"$ref":"#/components/schemas/TaxIdentity"},{"type":"null"}],"description":"Identity frozen on the source invoice at issue. Later profile edits do not change this document.","readOnly":true},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"credit_note_id":{"type":"string"},"credit_note_lines":{"items":{"$ref":"#/components/schemas/CreditNoteLine"},"type":"array"},"credit_note_number":{"description":"Assigned at issue and stable from then on. Absent while the credit note is a draft.","type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"external_reference_id":{"type":"string"},"invoice_id":{"type":"string"},"issued_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"latest_refund_status":{"enum":["pending","in_transit","succeeded","failed","requires_action","canceled","partially_succeeded"],"type":"string","x-enum-descriptions":["Pending.","In transit.","Succeeded.","Failed.","Requires action.","Canceled.","Partially succeeded."],"x-flint-enum":"open"},"memo":{"description":"Free text shown on the credit note, up to 4096 characters.","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"pending_refund_money":{"$ref":"#/components/schemas/Money"},"reason":{"description":"Why the invoice is being corrected. Shown on the credit note document.","enum":["returned_goods","order_adjustment","billing_error","goodwill","other"],"type":"string","x-enum-descriptions":["Returned goods.","Order adjustment.","Billing error.","Goodwill.","Other."],"x-flint-enum":"closed"},"refunded_money":{"$ref":"#/components/schemas/Money"},"seller_tax_identity":{"anyOf":[{"$ref":"#/components/schemas/TaxIdentity"},{"type":"null"}],"description":"Identity frozen on the source invoice at issue. Later profile edits do not change this document.","readOnly":true},"source_type":{"const":"installed_merchants"},"status":{"description":"draft while the credit note is editable, issued once it is numbered and frozen, void once retired.","enum":["draft","issued","void"],"type":"string","x-enum-descriptions":["Draft.","Issued.","Void."],"x-flint-enum":"open"},"total_money":{"$ref":"#/components/schemas/Money","description":"The face value of the credit note, the sum of its lines."},"unallocated_money":{"$ref":"#/components/schemas/Money","description":"Credit still available to allocate. Equals total_money at issue, falls as credit is applied, and rises again when an allocation is reversed."},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"version":{"description":"Current credit note version. Send this as expected_version when updating the draft.","format":"int64","minimum":1,"readOnly":true,"type":"integer"},"voided_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["created_at","credit_note_id","credit_note_lines","invoice_id","merchant_id","pending_refund_money","reason","refunded_money","status","total_money","unallocated_money","updated_at","version","source_type","mode","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"credit_note.issued"}}},"Webhook_credit_note_issued_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/CreditNote"},"event_type":{"const":"credit_note.issued"}}},"Webhook_credit_note_updated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"description":"A correction against an issued invoice. Credit notes reduce what is owed; refunds return what was already collected.","properties":{"buyer_tax_identity":{"anyOf":[{"$ref":"#/components/schemas/TaxIdentity"},{"type":"null"}],"description":"Identity frozen on the source invoice at issue. Later profile edits do not change this document.","readOnly":true},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"credit_note_id":{"type":"string"},"credit_note_lines":{"items":{"$ref":"#/components/schemas/CreditNoteLine"},"type":"array"},"credit_note_number":{"description":"Assigned at issue and stable from then on. Absent while the credit note is a draft.","type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"external_reference_id":{"type":"string"},"invoice_id":{"type":"string"},"issued_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"latest_refund_status":{"enum":["pending","in_transit","succeeded","failed","requires_action","canceled","partially_succeeded"],"type":"string","x-enum-descriptions":["Pending.","In transit.","Succeeded.","Failed.","Requires action.","Canceled.","Partially succeeded."],"x-flint-enum":"open"},"memo":{"description":"Free text shown on the credit note, up to 4096 characters.","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"pending_refund_money":{"$ref":"#/components/schemas/Money"},"reason":{"description":"Why the invoice is being corrected. Shown on the credit note document.","enum":["returned_goods","order_adjustment","billing_error","goodwill","other"],"type":"string","x-enum-descriptions":["Returned goods.","Order adjustment.","Billing error.","Goodwill.","Other."],"x-flint-enum":"closed"},"refunded_money":{"$ref":"#/components/schemas/Money"},"seller_tax_identity":{"anyOf":[{"$ref":"#/components/schemas/TaxIdentity"},{"type":"null"}],"description":"Identity frozen on the source invoice at issue. Later profile edits do not change this document.","readOnly":true},"source_type":{"const":"installed_merchants"},"status":{"description":"draft while the credit note is editable, issued once it is numbered and frozen, void once retired.","enum":["draft","issued","void"],"type":"string","x-enum-descriptions":["Draft.","Issued.","Void."],"x-flint-enum":"open"},"total_money":{"$ref":"#/components/schemas/Money","description":"The face value of the credit note, the sum of its lines."},"unallocated_money":{"$ref":"#/components/schemas/Money","description":"Credit still available to allocate. Equals total_money at issue, falls as credit is applied, and rises again when an allocation is reversed."},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"version":{"description":"Current credit note version. Send this as expected_version when updating the draft.","format":"int64","minimum":1,"readOnly":true,"type":"integer"},"voided_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["created_at","credit_note_id","credit_note_lines","invoice_id","merchant_id","pending_refund_money","reason","refunded_money","status","total_money","unallocated_money","updated_at","version","source_type","mode","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"credit_note.updated"}}},"Webhook_credit_note_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/CreditNote"},"event_type":{"const":"credit_note.updated"}}},"Webhook_credit_note_voided_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"description":"A correction against an issued invoice. Credit notes reduce what is owed; refunds return what was already collected.","properties":{"buyer_tax_identity":{"anyOf":[{"$ref":"#/components/schemas/TaxIdentity"},{"type":"null"}],"description":"Identity frozen on the source invoice at issue. Later profile edits do not change this document.","readOnly":true},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"credit_note_id":{"type":"string"},"credit_note_lines":{"items":{"$ref":"#/components/schemas/CreditNoteLine"},"type":"array"},"credit_note_number":{"description":"Assigned at issue and stable from then on. Absent while the credit note is a draft.","type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"external_reference_id":{"type":"string"},"invoice_id":{"type":"string"},"issued_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"latest_refund_status":{"enum":["pending","in_transit","succeeded","failed","requires_action","canceled","partially_succeeded"],"type":"string","x-enum-descriptions":["Pending.","In transit.","Succeeded.","Failed.","Requires action.","Canceled.","Partially succeeded."],"x-flint-enum":"open"},"memo":{"description":"Free text shown on the credit note, up to 4096 characters.","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"pending_refund_money":{"$ref":"#/components/schemas/Money"},"reason":{"description":"Why the invoice is being corrected. Shown on the credit note document.","enum":["returned_goods","order_adjustment","billing_error","goodwill","other"],"type":"string","x-enum-descriptions":["Returned goods.","Order adjustment.","Billing error.","Goodwill.","Other."],"x-flint-enum":"closed"},"refunded_money":{"$ref":"#/components/schemas/Money"},"seller_tax_identity":{"anyOf":[{"$ref":"#/components/schemas/TaxIdentity"},{"type":"null"}],"description":"Identity frozen on the source invoice at issue. Later profile edits do not change this document.","readOnly":true},"source_type":{"const":"installed_merchants"},"status":{"description":"draft while the credit note is editable, issued once it is numbered and frozen, void once retired.","enum":["draft","issued","void"],"type":"string","x-enum-descriptions":["Draft.","Issued.","Void."],"x-flint-enum":"open"},"total_money":{"$ref":"#/components/schemas/Money","description":"The face value of the credit note, the sum of its lines."},"unallocated_money":{"$ref":"#/components/schemas/Money","description":"Credit still available to allocate. Equals total_money at issue, falls as credit is applied, and rises again when an allocation is reversed."},"updated_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"version":{"description":"Current credit note version. Send this as expected_version when updating the draft.","format":"int64","minimum":1,"readOnly":true,"type":"integer"},"voided_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"}},"required":["created_at","credit_note_id","credit_note_lines","invoice_id","merchant_id","pending_refund_money","reason","refunded_money","status","total_money","unallocated_money","updated_at","version","source_type","mode","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"credit_note.voided"}}},"Webhook_credit_note_voided_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/CreditNote"},"event_type":{"const":"credit_note.voided"}}},"Webhook_customer_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"customer_id":{"type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["customer_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"customer.created"}}},"Webhook_customer_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"customer_id":{"type":"string"}},"required":["customer_id"],"type":"object"},"event_type":{"const":"customer.created"}}},"Webhook_customer_deletion_completed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"customer_deletion_request_id":{"type":"string"},"customer_id":{"type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"requested_at":{"format":"date-time","type":"string"},"resolved_at":{"format":"date-time","type":"string"},"retention_policy":{"enum":["retain_required_commerce_records"],"type":"string","x-enum-descriptions":["Retain required commerce records."],"x-flint-enum":"closed"},"source_type":{"const":"installed_merchants"},"status":{"enum":["completed"],"type":"string","x-enum-descriptions":["Completed."],"x-flint-enum":"open"}},"required":["customer_deletion_request_id","customer_id","status","retention_policy","requested_at","resolved_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"customer.deletion_completed"}}},"Webhook_customer_deletion_completed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"customer_deletion_request_id":{"type":"string"},"customer_id":{"type":"string"},"requested_at":{"format":"date-time","type":"string"},"resolved_at":{"format":"date-time","type":"string"},"retention_policy":{"enum":["retain_required_commerce_records"],"type":"string","x-enum-descriptions":["Retain required commerce records."],"x-flint-enum":"closed"},"status":{"enum":["completed"],"type":"string","x-enum-descriptions":["Completed."],"x-flint-enum":"open"}},"required":["customer_deletion_request_id","customer_id","status","retention_policy","requested_at","resolved_at"],"type":"object"},"event_type":{"const":"customer.deletion_completed"}}},"Webhook_customer_deletion_rejected_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"customer_deletion_request_id":{"type":"string"},"customer_id":{"type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"requested_at":{"format":"date-time","type":"string"},"resolved_at":{"format":"date-time","type":"string"},"retention_policy":{"enum":["retain_required_commerce_records"],"type":"string","x-enum-descriptions":["Retain required commerce records."],"x-flint-enum":"closed"},"source_type":{"const":"installed_merchants"},"status":{"enum":["rejected"],"type":"string","x-enum-descriptions":["Rejected."],"x-flint-enum":"open"}},"required":["customer_deletion_request_id","customer_id","status","retention_policy","requested_at","resolved_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"customer.deletion_rejected"}}},"Webhook_customer_deletion_rejected_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"customer_deletion_request_id":{"type":"string"},"customer_id":{"type":"string"},"requested_at":{"format":"date-time","type":"string"},"resolved_at":{"format":"date-time","type":"string"},"retention_policy":{"enum":["retain_required_commerce_records"],"type":"string","x-enum-descriptions":["Retain required commerce records."],"x-flint-enum":"closed"},"status":{"enum":["rejected"],"type":"string","x-enum-descriptions":["Rejected."],"x-flint-enum":"open"}},"required":["customer_deletion_request_id","customer_id","status","retention_policy","requested_at","resolved_at"],"type":"object"},"event_type":{"const":"customer.deletion_rejected"}}},"Webhook_customer_deletion_requested_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"customer_deletion_request_id":{"type":"string"},"customer_id":{"type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"requested_at":{"format":"date-time","type":"string"},"resolved_at":{"format":"date-time","type":"string"},"retention_policy":{"enum":["retain_required_commerce_records"],"type":"string","x-enum-descriptions":["Retain required commerce records."],"x-flint-enum":"closed"},"source_type":{"const":"installed_merchants"},"status":{"enum":["pending_review"],"type":"string","x-enum-descriptions":["Pending review."],"x-flint-enum":"open"}},"required":["customer_deletion_request_id","customer_id","status","retention_policy","requested_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"customer.deletion_requested"}}},"Webhook_customer_deletion_requested_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"customer_deletion_request_id":{"type":"string"},"customer_id":{"type":"string"},"requested_at":{"format":"date-time","type":"string"},"resolved_at":{"format":"date-time","type":"string"},"retention_policy":{"enum":["retain_required_commerce_records"],"type":"string","x-enum-descriptions":["Retain required commerce records."],"x-flint-enum":"closed"},"status":{"enum":["pending_review"],"type":"string","x-enum-descriptions":["Pending review."],"x-flint-enum":"open"}},"required":["customer_deletion_request_id","customer_id","status","retention_policy","requested_at"],"type":"object"},"event_type":{"const":"customer.deletion_requested"}}},"Webhook_customer_updated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"customer_id":{"type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["customer_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"customer.updated"}}},"Webhook_customer_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"customer_id":{"type":"string"}},"required":["customer_id"],"type":"object"},"event_type":{"const":"customer.updated"}}},"Webhook_delivery_location_set_activated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_location_set.activated"}}},"Webhook_delivery_location_set_activated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_location_set.activated"}}},"Webhook_delivery_location_set_archived_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_location_set.archived"}}},"Webhook_delivery_location_set_archived_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_location_set.archived"}}},"Webhook_delivery_location_set_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_location_set.created"}}},"Webhook_delivery_location_set_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_location_set.created"}}},"Webhook_delivery_location_set_deactivated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_location_set.deactivated"}}},"Webhook_delivery_location_set_deactivated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_location_set.deactivated"}}},"Webhook_delivery_location_set_updated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_location_set.updated"}}},"Webhook_delivery_location_set_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_location_set.updated"}}},"Webhook_delivery_method_activated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_method.activated"}}},"Webhook_delivery_method_activated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_method.activated"}}},"Webhook_delivery_method_archived_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_method.archived"}}},"Webhook_delivery_method_archived_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_method.archived"}}},"Webhook_delivery_method_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_method.created"}}},"Webhook_delivery_method_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_method.created"}}},"Webhook_delivery_method_deactivated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_method.deactivated"}}},"Webhook_delivery_method_deactivated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_method.deactivated"}}},"Webhook_delivery_method_updated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_method.updated"}}},"Webhook_delivery_method_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_method.updated"}}},"Webhook_delivery_profile_activated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_profile.activated"}}},"Webhook_delivery_profile_activated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_profile.activated"}}},"Webhook_delivery_profile_archived_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_profile.archived"}}},"Webhook_delivery_profile_archived_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_profile.archived"}}},"Webhook_delivery_profile_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_profile.created"}}},"Webhook_delivery_profile_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_profile.created"}}},"Webhook_delivery_profile_deactivated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_profile.deactivated"}}},"Webhook_delivery_profile_deactivated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_profile.deactivated"}}},"Webhook_delivery_profile_updated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_profile.updated"}}},"Webhook_delivery_profile_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_profile.updated"}}},"Webhook_delivery_rate_archived_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_rate.archived"}}},"Webhook_delivery_rate_archived_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_rate.archived"}}},"Webhook_delivery_rate_callback_activated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_rate_callback.activated"}}},"Webhook_delivery_rate_callback_activated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_rate_callback.activated"}}},"Webhook_delivery_rate_callback_archived_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_rate_callback.archived"}}},"Webhook_delivery_rate_callback_archived_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_rate_callback.archived"}}},"Webhook_delivery_rate_callback_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_rate_callback.created"}}},"Webhook_delivery_rate_callback_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_rate_callback.created"}}},"Webhook_delivery_rate_callback_deactivated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_rate_callback.deactivated"}}},"Webhook_delivery_rate_callback_deactivated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_rate_callback.deactivated"}}},"Webhook_delivery_rate_callback_updated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_rate_callback.updated"}}},"Webhook_delivery_rate_callback_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_rate_callback.updated"}}},"Webhook_delivery_rate_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_rate.created"}}},"Webhook_delivery_rate_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_rate.created"}}},"Webhook_delivery_rate_updated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_rate.updated"}}},"Webhook_delivery_rate_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_rate.updated"}}},"Webhook_delivery_revocation_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_revocation.created"}}},"Webhook_delivery_revocation_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_revocation.created"}}},"Webhook_delivery_selection_committed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_selection.committed"}}},"Webhook_delivery_selection_committed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_selection.committed"}}},"Webhook_delivery_zone_activated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_zone.activated"}}},"Webhook_delivery_zone_activated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_zone.activated"}}},"Webhook_delivery_zone_archived_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_zone.archived"}}},"Webhook_delivery_zone_archived_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_zone.archived"}}},"Webhook_delivery_zone_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_zone.created"}}},"Webhook_delivery_zone_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_zone.created"}}},"Webhook_delivery_zone_deactivated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_zone.deactivated"}}},"Webhook_delivery_zone_deactivated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_zone.deactivated"}}},"Webhook_delivery_zone_updated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"delivery_zone.updated"}}},"Webhook_delivery_zone_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"delivery_zone.updated"}}},"Webhook_dispute_closed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"dispute_id":{"type":"string"}},"required":["dispute_id"],"type":"object"},"event_type":{"const":"dispute.closed"}}},"Webhook_dispute_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"dispute_id":{"type":"string"}},"required":["dispute_id"],"type":"object"},"event_type":{"const":"dispute.created"}}},"Webhook_dispute_lost_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"dispute_id":{"type":"string"}},"required":["dispute_id"],"type":"object"},"event_type":{"const":"dispute.lost"}}},"Webhook_dispute_needs_response_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"dispute_id":{"type":"string"}},"required":["dispute_id"],"type":"object"},"event_type":{"const":"dispute.needs_response"}}},"Webhook_dispute_prevented_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"dispute_id":{"type":"string"}},"required":["dispute_id"],"type":"object"},"event_type":{"const":"dispute.prevented"}}},"Webhook_dispute_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"dispute_id":{"type":"string"}},"required":["dispute_id"],"type":"object"},"event_type":{"const":"dispute.updated"}}},"Webhook_dispute_warning_closed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"dispute_id":{"type":"string"}},"required":["dispute_id"],"type":"object"},"event_type":{"const":"dispute.warning_closed"}}},"Webhook_dispute_won_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"dispute_id":{"type":"string"}},"required":["dispute_id"],"type":"object"},"event_type":{"const":"dispute.won"}}},"Webhook_fraud_warning_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"properties":{"actionable":{"type":"boolean"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"dispute":{"anyOf":[{"$ref":"#/components/schemas/Dispute"},{"type":"null"}]},"dispute_id":{"type":["string","null"]},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"fraud_type":{"enum":["card_never_received","fraudulent_card_application","made_with_counterfeit_card","made_with_lost_card","made_with_stolen_card","unauthorized_use_of_card","other"],"type":"string","x-enum-descriptions":["Card never received.","Fraudulent card application.","Made with counterfeit card.","Made with lost card.","Made with stolen card.","Unauthorized use of card.","Other."],"x-flint-enum":"closed"},"fraud_warning_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"payment_intent":{"anyOf":[{"$ref":"#/components/schemas/ExpandedPaymentIntentSummary"},{"type":"null"}]},"payment_intent_id":{"type":"string"},"payment_summary":{"$ref":"#/components/schemas/PublicFraudWarningPaymentSummary"},"reported_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"}},"required":["fraud_warning_id","payment_intent_id","fraud_type","actionable","dispute_id","payment_summary","reported_at","created_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"fraud_warning.created"}}},"Webhook_fraud_warning_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/FraudWarning"},"event_type":{"const":"fraud_warning.created"}}},"Webhook_fraud_warning_updated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"properties":{"actionable":{"type":"boolean"},"created_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"dispute":{"anyOf":[{"$ref":"#/components/schemas/Dispute"},{"type":"null"}]},"dispute_id":{"type":["string","null"]},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"fraud_type":{"enum":["card_never_received","fraudulent_card_application","made_with_counterfeit_card","made_with_lost_card","made_with_stolen_card","unauthorized_use_of_card","other"],"type":"string","x-enum-descriptions":["Card never received.","Fraudulent card application.","Made with counterfeit card.","Made with lost card.","Made with stolen card.","Unauthorized use of card.","Other."],"x-flint-enum":"closed"},"fraud_warning_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"payment_intent":{"anyOf":[{"$ref":"#/components/schemas/ExpandedPaymentIntentSummary"},{"type":"null"}]},"payment_intent_id":{"type":"string"},"payment_summary":{"$ref":"#/components/schemas/PublicFraudWarningPaymentSummary"},"reported_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"}},"required":["fraud_warning_id","payment_intent_id","fraud_type","actionable","dispute_id","payment_summary","reported_at","created_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"fraud_warning.updated"}}},"Webhook_fraud_warning_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/FraudWarning"},"event_type":{"const":"fraud_warning.updated"}}},"Webhook_inventory_action_required_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"inventory.action_required"}}},"Webhook_inventory_count_applied_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"inventory.count.applied"}}},"Webhook_inventory_level_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"inventory.level.updated"}}},"Webhook_inventory_receipt_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"inventory.receipt.created"}}},"Webhook_inventory_reservation_at_risk_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"inventory.reservation.at_risk"}}},"Webhook_inventory_reservation_closed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"inventory.reservation.closed"}}},"Webhook_inventory_reservation_committed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"inventory.reservation.committed"}}},"Webhook_inventory_reservation_consumed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"inventory.reservation.consumed"}}},"Webhook_inventory_reservation_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"inventory.reservation.created"}}},"Webhook_inventory_reservation_hold_expired_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"inventory.reservation.hold_expired"}}},"Webhook_inventory_reservation_released_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"inventory.reservation.released"}}},"Webhook_inventory_shortage_detected_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"inventory.shortage.detected"}}},"Webhook_inventory_transfer_closed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"inventory.transfer.closed"}}},"Webhook_inventory_transfer_departed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"inventory.transfer.departed"}}},"Webhook_inventory_transfer_lost_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"inventory.transfer.lost"}}},"Webhook_inventory_transfer_received_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"inventory.transfer.received"}}},"Webhook_inventory_transfer_returned_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"inventory.transfer.returned"}}},"Webhook_invoice_collection_block_resolved_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"collection_block_reason":{"enum":["inventory_restored"],"type":"string","x-enum-descriptions":["Inventory restored."],"x-flint-enum":"closed"},"collection_block_status":{"enum":["resolved"],"type":"string","x-enum-descriptions":["Resolved."],"x-flint-enum":"open"},"collection_block_updated_at":{"format":"date-time","type":"string"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"partner_app_install_id":{"type":"string"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"subscription_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","collection_block_status","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.collection_block_resolved"}}},"Webhook_invoice_collection_block_resolved_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"collection_block_reason":{"enum":["inventory_restored"],"type":"string","x-enum-descriptions":["Inventory restored."],"x-flint-enum":"closed"},"collection_block_status":{"enum":["resolved"],"type":"string","x-enum-descriptions":["Resolved."],"x-flint-enum":"open"},"collection_block_updated_at":{"format":"date-time","type":"string"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"subscription_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","collection_block_status"],"type":"object"},"event_type":{"const":"invoice.collection_block_resolved"}}},"Webhook_invoice_collection_blocked_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"collection_block_reason":{"enum":["inventory_unavailable"],"type":"string","x-enum-descriptions":["Inventory unavailable."],"x-flint-enum":"closed"},"collection_block_status":{"enum":["inventory_blocked"],"type":"string","x-enum-descriptions":["Inventory blocked."],"x-flint-enum":"open"},"collection_block_updated_at":{"format":"date-time","type":"string"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"partner_app_install_id":{"type":"string"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"subscription_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","collection_block_status","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.collection_blocked"}}},"Webhook_invoice_collection_blocked_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"collection_block_reason":{"enum":["inventory_unavailable"],"type":"string","x-enum-descriptions":["Inventory unavailable."],"x-flint-enum":"closed"},"collection_block_status":{"enum":["inventory_blocked"],"type":"string","x-enum-descriptions":["Inventory blocked."],"x-flint-enum":"open"},"collection_block_updated_at":{"format":"date-time","type":"string"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"subscription_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","collection_block_status"],"type":"object"},"event_type":{"const":"invoice.collection_blocked"}}},"Webhook_invoice_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"partner_app_install_id":{"type":"string"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.created"}}},"Webhook_invoice_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at"],"type":"object"},"event_type":{"const":"invoice.created"}}},"Webhook_invoice_credited_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"closed_at":{"format":"date-time","type":"string"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"credit_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"partner_app_install_id":{"type":"string"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","credit_money","closed_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.credited"}}},"Webhook_invoice_credited_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"closed_at":{"format":"date-time","type":"string"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"credit_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","credit_money","closed_at"],"type":"object"},"event_type":{"const":"invoice.credited"}}},"Webhook_invoice_delivery_failed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.delivery_failed"}}},"Webhook_invoice_delivery_failed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"invoice_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version"],"type":"object"},"event_type":{"const":"invoice.delivery_failed"}}},"Webhook_invoice_delivery_succeeded_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.delivery_succeeded"}}},"Webhook_invoice_delivery_succeeded_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"invoice_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version"],"type":"object"},"event_type":{"const":"invoice.delivery_succeeded"}}},"Webhook_invoice_issue_failed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"error_code":{"type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"partner_app_install_id":{"type":"string"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","error_code","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.issue_failed"}}},"Webhook_invoice_issue_failed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"error_code":{"type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","error_code"],"type":"object"},"event_type":{"const":"invoice.issue_failed"}}},"Webhook_invoice_issued_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"partner_app_install_id":{"type":"string"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","issued_at","collection_mode","delivery_mode","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.issued"}}},"Webhook_invoice_issued_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","issued_at","collection_mode","delivery_mode"],"type":"object"},"event_type":{"const":"invoice.issued"}}},"Webhook_invoice_late_fee_assessed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"invoice_late_fee_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_schedule_entry_id":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"outstanding_money":{"$ref":"#/components/schemas/Money"},"partner_app_install_id":{"type":"string"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_late_fee_id","amount_money","outstanding_money","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.late_fee_assessed"}}},"Webhook_invoice_late_fee_assessed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"invoice_id":{"type":"string"},"invoice_late_fee_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_schedule_entry_id":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"$ref":"#/components/schemas/Money"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_late_fee_id","amount_money","outstanding_money"],"type":"object"},"event_type":{"const":"invoice.late_fee_assessed"}}},"Webhook_invoice_late_fee_due_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"base_outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"due_at":{"format":"date-time","type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_schedule_entry_id":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"late_fee_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"late_fee_policy":{"$ref":"#/components/schemas/InvoiceLateFeePolicy"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"partner_app_install_id":{"type":"string"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","due_at","late_fee_money","base_outstanding_money","late_fee_policy","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.late_fee_due"}}},"Webhook_invoice_late_fee_due_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"base_outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"due_at":{"format":"date-time","type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_schedule_entry_id":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"late_fee_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"late_fee_policy":{"$ref":"#/components/schemas/InvoiceLateFeePolicy"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","due_at","late_fee_money","base_outstanding_money","late_fee_policy"],"type":"object"},"event_type":{"const":"invoice.late_fee_due"}}},"Webhook_invoice_late_fee_waived_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"invoice_late_fee_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_schedule_entry_id":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"outstanding_money":{"$ref":"#/components/schemas/Money"},"partner_app_install_id":{"type":"string"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_late_fee_id","amount_money","outstanding_money","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.late_fee_waived"}}},"Webhook_invoice_late_fee_waived_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"invoice_id":{"type":"string"},"invoice_late_fee_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_schedule_entry_id":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"$ref":"#/components/schemas/Money"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_late_fee_id","amount_money","outstanding_money"],"type":"object"},"event_type":{"const":"invoice.late_fee_waived"}}},"Webhook_invoice_manual_payment_recorded_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.manual_payment_recorded"}}},"Webhook_invoice_manual_payment_recorded_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"invoice_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version"],"type":"object"},"event_type":{"const":"invoice.manual_payment_recorded"}}},"Webhook_invoice_manual_payment_reversed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.manual_payment_reversed"}}},"Webhook_invoice_manual_payment_reversed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"invoice_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version"],"type":"object"},"event_type":{"const":"invoice.manual_payment_reversed"}}},"Webhook_invoice_marked_uncollectible_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"partner_app_install_id":{"type":"string"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"uncollectible_at":{"format":"date-time","type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"},"written_off_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","written_off_money","uncollectible_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.marked_uncollectible"}}},"Webhook_invoice_marked_uncollectible_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"uncollectible_at":{"format":"date-time","type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"},"written_off_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","written_off_money","uncollectible_at"],"type":"object"},"event_type":{"const":"invoice.marked_uncollectible"}}},"Webhook_invoice_overdue_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"due_at":{"format":"date-time","type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_schedule_entry_id":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"partner_app_install_id":{"type":"string"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","due_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.overdue"}}},"Webhook_invoice_overdue_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"due_at":{"format":"date-time","type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_schedule_entry_id":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","due_at"],"type":"object"},"event_type":{"const":"invoice.overdue"}}},"Webhook_invoice_paid_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.paid"}}},"Webhook_invoice_paid_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"invoice_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version"],"type":"object"},"event_type":{"const":"invoice.paid"}}},"Webhook_invoice_partially_paid_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.partially_paid"}}},"Webhook_invoice_partially_paid_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"invoice_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version"],"type":"object"},"event_type":{"const":"invoice.partially_paid"}}},"Webhook_invoice_partially_refunded_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.partially_refunded"}}},"Webhook_invoice_partially_refunded_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"invoice_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version"],"type":"object"},"event_type":{"const":"invoice.partially_refunded"}}},"Webhook_invoice_payment_attempt_canceled_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"checkout_session_id":{"type":"string"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"expected_amount_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_payment_attempt_id":{"type":"string"},"invoice_schedule_entry_id":{"pattern":"^invse_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"issued_at":{"format":"date-time","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"partner_app_install_id":{"type":"string"},"payment_attempt_expires_at":{"format":"date-time","type":"string"},"payment_attempt_status":{"enum":["canceled"],"type":"string","x-enum-descriptions":["Canceled."],"x-flint-enum":"open"},"payment_attempt_updated_at":{"format":"date-time","type":"string"},"payment_intent_id":{"type":"string"},"payment_rail":{"enum":["card","ach_debit","manual"],"type":"string","x-enum-descriptions":["Card.","Ach debit.","Manual."],"x-flint-enum":"closed"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","invoice_payment_attempt_id","payment_attempt_status","payment_attempt_updated_at","payment_rail","expected_amount_money","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.payment_attempt_canceled"}}},"Webhook_invoice_payment_attempt_canceled_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"checkout_session_id":{"type":"string"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"expected_amount_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_payment_attempt_id":{"type":"string"},"invoice_schedule_entry_id":{"pattern":"^invse_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"payment_attempt_expires_at":{"format":"date-time","type":"string"},"payment_attempt_status":{"enum":["canceled"],"type":"string","x-enum-descriptions":["Canceled."],"x-flint-enum":"open"},"payment_attempt_updated_at":{"format":"date-time","type":"string"},"payment_intent_id":{"type":"string"},"payment_rail":{"enum":["card","ach_debit","manual"],"type":"string","x-enum-descriptions":["Card.","Ach debit.","Manual."],"x-flint-enum":"closed"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","invoice_payment_attempt_id","payment_attempt_status","payment_attempt_updated_at","payment_rail","expected_amount_money"],"type":"object"},"event_type":{"const":"invoice.payment_attempt_canceled"}}},"Webhook_invoice_payment_attempt_expired_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"checkout_session_id":{"type":"string"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"expected_amount_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_payment_attempt_id":{"type":"string"},"invoice_schedule_entry_id":{"pattern":"^invse_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"issued_at":{"format":"date-time","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"partner_app_install_id":{"type":"string"},"payment_attempt_expires_at":{"format":"date-time","type":"string"},"payment_attempt_status":{"enum":["expired"],"type":"string","x-enum-descriptions":["Expired."],"x-flint-enum":"open"},"payment_attempt_updated_at":{"format":"date-time","type":"string"},"payment_intent_id":{"type":"string"},"payment_rail":{"enum":["card","ach_debit","manual"],"type":"string","x-enum-descriptions":["Card.","Ach debit.","Manual."],"x-flint-enum":"closed"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","invoice_payment_attempt_id","payment_attempt_status","payment_attempt_updated_at","payment_rail","expected_amount_money","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.payment_attempt_expired"}}},"Webhook_invoice_payment_attempt_expired_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"checkout_session_id":{"type":"string"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"expected_amount_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_payment_attempt_id":{"type":"string"},"invoice_schedule_entry_id":{"pattern":"^invse_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"payment_attempt_expires_at":{"format":"date-time","type":"string"},"payment_attempt_status":{"enum":["expired"],"type":"string","x-enum-descriptions":["Expired."],"x-flint-enum":"open"},"payment_attempt_updated_at":{"format":"date-time","type":"string"},"payment_intent_id":{"type":"string"},"payment_rail":{"enum":["card","ach_debit","manual"],"type":"string","x-enum-descriptions":["Card.","Ach debit.","Manual."],"x-flint-enum":"closed"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","invoice_payment_attempt_id","payment_attempt_status","payment_attempt_updated_at","payment_rail","expected_amount_money"],"type":"object"},"event_type":{"const":"invoice.payment_attempt_expired"}}},"Webhook_invoice_payment_failed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"checkout_session_id":{"type":"string"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"expected_amount_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"failure_code":{"enum":["card_declined","insufficient_funds","bank_account_closed","bank_account_not_found","bank_debit_not_authorized","bank_account_restricted","bank_debit_limit_exceeded","authentication_required","payment_blocked","expired_card","incorrect_cvc","processing_error","payment_method_unavailable","payment_method_declined","payment_not_completed","payment_action_expired","payment_method_temporarily_unavailable","payment_failed"],"type":"string","x-enum-descriptions":["Card declined.","Insufficient funds.","Bank account closed.","Bank account not found.","Bank debit not authorized.","Bank account restricted.","Bank debit limit exceeded.","Authentication required.","Payment blocked.","Expired card.","Incorrect cvc.","Processing error.","Payment method unavailable.","Payment method declined.","Payment not completed.","Payment action expired.","Payment method temporarily unavailable.","Payment failed."],"x-flint-enum":"closed"},"failure_message":{"type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_payment_attempt_id":{"type":"string"},"invoice_schedule_entry_id":{"pattern":"^invse_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"issued_at":{"format":"date-time","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"partner_app_install_id":{"type":"string"},"payment_attempt_expires_at":{"format":"date-time","type":"string"},"payment_attempt_status":{"enum":["failed"],"type":"string","x-enum-descriptions":["Failed."],"x-flint-enum":"open"},"payment_attempt_updated_at":{"format":"date-time","type":"string"},"payment_intent_id":{"type":"string"},"payment_rail":{"enum":["card","ach_debit","manual"],"type":"string","x-enum-descriptions":["Card.","Ach debit.","Manual."],"x-flint-enum":"closed"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","invoice_payment_attempt_id","payment_attempt_status","payment_attempt_updated_at","payment_rail","expected_amount_money","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.payment_failed"}}},"Webhook_invoice_payment_failed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"checkout_session_id":{"type":"string"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"expected_amount_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"failure_code":{"enum":["card_declined","insufficient_funds","bank_account_closed","bank_account_not_found","bank_debit_not_authorized","bank_account_restricted","bank_debit_limit_exceeded","authentication_required","payment_blocked","expired_card","incorrect_cvc","processing_error","payment_method_unavailable","payment_method_declined","payment_not_completed","payment_action_expired","payment_method_temporarily_unavailable","payment_failed"],"type":"string","x-enum-descriptions":["Card declined.","Insufficient funds.","Bank account closed.","Bank account not found.","Bank debit not authorized.","Bank account restricted.","Bank debit limit exceeded.","Authentication required.","Payment blocked.","Expired card.","Incorrect cvc.","Processing error.","Payment method unavailable.","Payment method declined.","Payment not completed.","Payment action expired.","Payment method temporarily unavailable.","Payment failed."],"x-flint-enum":"closed"},"failure_message":{"type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_payment_attempt_id":{"type":"string"},"invoice_schedule_entry_id":{"pattern":"^invse_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"payment_attempt_expires_at":{"format":"date-time","type":"string"},"payment_attempt_status":{"enum":["failed"],"type":"string","x-enum-descriptions":["Failed."],"x-flint-enum":"open"},"payment_attempt_updated_at":{"format":"date-time","type":"string"},"payment_intent_id":{"type":"string"},"payment_rail":{"enum":["card","ach_debit","manual"],"type":"string","x-enum-descriptions":["Card.","Ach debit.","Manual."],"x-flint-enum":"closed"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","invoice_payment_attempt_id","payment_attempt_status","payment_attempt_updated_at","payment_rail","expected_amount_money"],"type":"object"},"event_type":{"const":"invoice.payment_failed"}}},"Webhook_invoice_payment_processing_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"expected_amount_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"expected_settlement_at":{"format":"date-time","type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_payment_attempt_id":{"type":"string"},"invoice_schedule_entry_id":{"pattern":"^invse_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"issued_at":{"format":"date-time","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"partner_app_install_id":{"type":"string"},"payment_attempt_status":{"enum":["processing"],"type":"string","x-enum-descriptions":["Processing."],"x-flint-enum":"open"},"payment_attempt_updated_at":{"format":"date-time","type":"string"},"payment_intent_id":{"type":"string"},"payment_rail":{"enum":["ach_debit"],"type":"string","x-enum-descriptions":["Ach debit."],"x-flint-enum":"closed"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","invoice_payment_attempt_id","payment_attempt_status","payment_attempt_updated_at","payment_rail","expected_amount_money","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.payment_processing"}}},"Webhook_invoice_payment_processing_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"expected_amount_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"expected_settlement_at":{"format":"date-time","type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_payment_attempt_id":{"type":"string"},"invoice_schedule_entry_id":{"pattern":"^invse_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"payment_attempt_status":{"enum":["processing"],"type":"string","x-enum-descriptions":["Processing."],"x-flint-enum":"open"},"payment_attempt_updated_at":{"format":"date-time","type":"string"},"payment_intent_id":{"type":"string"},"payment_rail":{"enum":["ach_debit"],"type":"string","x-enum-descriptions":["Ach debit."],"x-flint-enum":"closed"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","invoice_payment_attempt_id","payment_attempt_status","payment_attempt_updated_at","payment_rail","expected_amount_money"],"type":"object"},"event_type":{"const":"invoice.payment_processing"}}},"Webhook_invoice_refunded_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.refunded"}}},"Webhook_invoice_refunded_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"invoice_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version"],"type":"object"},"event_type":{"const":"invoice.refunded"}}},"Webhook_invoice_reminder_due_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"due_at":{"format":"date-time","type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_schedule_entry_id":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"partner_app_install_id":{"type":"string"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","due_at","delivery_mode","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.reminder_due"}}},"Webhook_invoice_reminder_due_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"due_at":{"format":"date-time","type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_schedule_entry_id":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","due_at","delivery_mode"],"type":"object"},"event_type":{"const":"invoice.reminder_due"}}},"Webhook_invoice_sent_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.sent"}}},"Webhook_invoice_sent_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"invoice_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version"],"type":"object"},"event_type":{"const":"invoice.sent"}}},"Webhook_invoice_updated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"partner_app_install_id":{"type":"string"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.updated"}}},"Webhook_invoice_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at"],"type":"object"},"event_type":{"const":"invoice.updated"}}},"Webhook_invoice_voided_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"invoice_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"invoice.voided"}}},"Webhook_invoice_voided_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"invoice_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version"],"type":"object"},"event_type":{"const":"invoice.voided"}}},"Webhook_merchant_billing_balance_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"available_credit_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"merchant_billing_balance_id":{"type":"string"},"observed_at":{"format":"date-time","type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"}},"required":["merchant_billing_balance_id","outstanding_money","available_credit_money","observed_at"],"type":"object"},"event_type":{"const":"merchant_billing_balance.updated"}}},"Webhook_merchant_readiness_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"business_name":{"type":"string"},"merchant_environment_id":{"type":"string"},"merchant_id":{"type":"string"},"observed_at":{"format":"date-time","type":"string"},"payments":{"additionalProperties":false,"properties":{"next_actions":{"items":{"additionalProperties":false,"properties":{"action_type":{"enum":["create_merchant_account_session"],"type":"string","x-enum-descriptions":["Create merchant account session."],"x-flint-enum":"closed"},"expires_at":{"format":"date-time","type":"string"},"url":{"type":"string"}},"required":["action_type"],"type":"object"},"type":"array"},"status":{"enum":["ready","blocked","pending","not_available","not_requested"],"type":"string","x-enum-descriptions":["Ready.","Blocked.","Pending.","Not available.","Not requested."],"x-flint-enum":"open"},"status_reason":{"enum":["requirements_due","requirements_past_due","pending_verification","disabled_by_platform_policy","service_unavailable","onboarding_not_started",null],"type":["string","null"],"x-enum-descriptions":["Requirements due.","Requirements past due.","Pending verification.","Disabled by platform policy.","Service unavailable.","Onboarding not started.","Null."],"x-flint-enum":"closed"}},"required":["status","status_reason","next_actions"],"type":"object"},"payouts":{"additionalProperties":false,"properties":{"next_actions":{"items":{"additionalProperties":false,"properties":{"action_type":{"enum":["create_merchant_account_session"],"type":"string","x-enum-descriptions":["Create merchant account session."],"x-flint-enum":"closed"},"expires_at":{"format":"date-time","type":"string"},"url":{"type":"string"}},"required":["action_type"],"type":"object"},"type":"array"},"status":{"enum":["ready","blocked","pending","not_available","not_requested"],"type":"string","x-enum-descriptions":["Ready.","Blocked.","Pending.","Not available.","Not requested."],"x-flint-enum":"open"},"status_reason":{"enum":["requirements_due","requirements_past_due","pending_verification","disabled_by_platform_policy","service_unavailable","onboarding_not_started",null],"type":["string","null"],"x-enum-descriptions":["Requirements due.","Requirements past due.","Pending verification.","Disabled by platform policy.","Service unavailable.","Onboarding not started.","Null."],"x-flint-enum":"closed"}},"required":["status","status_reason","next_actions"],"type":"object"},"requirements":{"additionalProperties":false,"properties":{"current_deadline_at":{"format":"date-time","type":["string","null"]},"currently_due":{"items":{"type":"string"},"type":"array"},"disabled_reason":{"enum":["account_attention_required","account_paused","account_rejected","account_requirements_due","account_under_review","requirements_past_due","requirements_pending_verification",null],"type":["string","null"],"x-enum-descriptions":["Account attention required.","Account paused.","Account rejected.","Account requirements due.","Account under review.","Requirements past due.","Requirements pending verification.","Null."],"x-flint-enum":"closed"},"eventually_due":{"items":{"type":"string"},"type":"array"},"past_due":{"items":{"type":"string"},"type":"array"},"pending_verification":{"items":{"type":"string"},"type":"array"}},"required":["currently_due","past_due","eventually_due","pending_verification","disabled_reason"],"type":"object"}},"required":["merchant_id","merchant_environment_id","payments","payouts","requirements","observed_at"],"type":"object"},"event_type":{"const":"merchant.readiness.updated"}}},"Webhook_merchant_subscription_invoice_issued_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/MerchantSubscriptionInvoice"},"event_type":{"const":"merchant_subscription_invoice.issued"}}},"Webhook_merchant_subscription_invoice_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/MerchantSubscriptionInvoice"},"event_type":{"const":"merchant_subscription_invoice.updated"}}},"Webhook_order_closed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"customer_id":{"type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"order_number":{"type":"string"},"partner_app_install_id":{"type":"string"},"payment_status":{"enum":["unpaid","partially_paid","paid"],"type":"string","x-enum-descriptions":["Unpaid.","Partially paid.","Paid."],"x-flint-enum":"open"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id","status","payment_status","refund_status","resource_updated_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.closed"}}},"Webhook_order_closed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"customer_id":{"type":"string"},"order_id":{"type":"string"},"order_number":{"type":"string"},"payment_status":{"enum":["unpaid","partially_paid","paid"],"type":"string","x-enum-descriptions":["Unpaid.","Partially paid.","Paid."],"x-flint-enum":"open"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id","status","payment_status","refund_status","resource_updated_at"],"type":"object"},"event_type":{"const":"order.closed"}}},"Webhook_order_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"customer_id":{"type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"order_number":{"type":"string"},"origin":{"enum":["virtual_terminal","payment_link","checkout","api","subscription"],"type":"string","x-enum-descriptions":["Virtual terminal.","Payment link.","Checkout.","Api.","Subscription."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"payment_status":{"enum":["unpaid","partially_paid","paid"],"type":"string","x-enum-descriptions":["Unpaid.","Partially paid.","Paid."],"x-flint-enum":"open"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id","status","payment_status","refund_status","resource_updated_at","origin","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.created"}}},"Webhook_order_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"customer_id":{"type":"string"},"order_id":{"type":"string"},"order_number":{"type":"string"},"origin":{"enum":["virtual_terminal","payment_link","checkout","api","subscription"],"type":"string","x-enum-descriptions":["Virtual terminal.","Payment link.","Checkout.","Api.","Subscription."],"x-flint-enum":"closed"},"payment_status":{"enum":["unpaid","partially_paid","paid"],"type":"string","x-enum-descriptions":["Unpaid.","Partially paid.","Paid."],"x-flint-enum":"open"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id","status","payment_status","refund_status","resource_updated_at","origin"],"type":"object"},"event_type":{"const":"order.created"}}},"Webhook_order_fulfillment_completed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["order_id","fulfillment_id","order","fulfillment","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.fulfillment.completed"}}},"Webhook_order_fulfillment_completed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_id":{"type":"string"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"}},"required":["order_id","fulfillment_id","order","fulfillment"],"type":"object"},"event_type":{"const":"order.fulfillment.completed"}}},"Webhook_order_fulfillment_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["order_id","fulfillment_id","order","fulfillment","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.fulfillment.created"}}},"Webhook_order_fulfillment_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_id":{"type":"string"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"}},"required":["order_id","fulfillment_id","order","fulfillment"],"type":"object"},"event_type":{"const":"order.fulfillment.created"}}},"Webhook_order_fulfillment_event_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"fulfillment_event":{"additionalProperties":false,"properties":{"buyer_notification_behavior":{"enum":["default","suppress","request"],"type":"string","x-enum-descriptions":["Default.","Suppress.","Request."],"x-flint-enum":"closed"},"custom_details":{"additionalProperties":{"type":"string"},"type":"object"},"event_type":{"enum":["accepted","preparing","picked","packed","ready","shipped","dispatched","in_transit","out_for_delivery","delivered","delivery_attempted","tracking_updated","exception","returned","completed","canceled","failed","no_show","custom"],"type":"string","x-enum-descriptions":["Accepted.","Preparing.","Picked.","Packed.","Ready.","Shipped.","Dispatched.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Tracking updated.","Exception.","Returned.","Completed.","Canceled.","Failed.","No show.","Custom."],"x-flint-enum":"closed"},"external_event_id":{"type":"string"},"external_status":{"type":"string"},"external_system":{"type":"string"},"fulfillment_event_id":{"type":"string"},"fulfillment_id":{"type":"string"},"fulfillment_status_update_id":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"package_id":{"type":"string"},"package_status_update_id":{"type":"string"},"received_at":{"format":"date-time","type":"string"},"shipment_id":{"type":"string"},"shipment_status_update_id":{"type":"string"},"target_package_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"target_quantity_effect":{"enum":["preserve","fulfill","release"],"type":"string","x-enum-descriptions":["Preserve.","Fulfill.","Release."],"x-flint-enum":"closed"},"target_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"}},"required":["fulfillment_event_id","order_id","fulfillment_id","event_type","buyer_notification_behavior","occurred_at","received_at"],"type":"object"},"fulfillment_event_id":{"type":"string"},"fulfillment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["order_id","fulfillment_id","fulfillment_event_id","fulfillment_event","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.fulfillment.event.created"}}},"Webhook_order_fulfillment_event_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"fulfillment_event":{"additionalProperties":false,"properties":{"buyer_notification_behavior":{"enum":["default","suppress","request"],"type":"string","x-enum-descriptions":["Default.","Suppress.","Request."],"x-flint-enum":"closed"},"custom_details":{"additionalProperties":{"type":"string"},"type":"object"},"event_type":{"enum":["accepted","preparing","picked","packed","ready","shipped","dispatched","in_transit","out_for_delivery","delivered","delivery_attempted","tracking_updated","exception","returned","completed","canceled","failed","no_show","custom"],"type":"string","x-enum-descriptions":["Accepted.","Preparing.","Picked.","Packed.","Ready.","Shipped.","Dispatched.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Tracking updated.","Exception.","Returned.","Completed.","Canceled.","Failed.","No show.","Custom."],"x-flint-enum":"closed"},"external_event_id":{"type":"string"},"external_status":{"type":"string"},"external_system":{"type":"string"},"fulfillment_event_id":{"type":"string"},"fulfillment_id":{"type":"string"},"fulfillment_status_update_id":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"package_id":{"type":"string"},"package_status_update_id":{"type":"string"},"received_at":{"format":"date-time","type":"string"},"shipment_id":{"type":"string"},"shipment_status_update_id":{"type":"string"},"target_package_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"target_quantity_effect":{"enum":["preserve","fulfill","release"],"type":"string","x-enum-descriptions":["Preserve.","Fulfill.","Release."],"x-flint-enum":"closed"},"target_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"}},"required":["fulfillment_event_id","order_id","fulfillment_id","event_type","buyer_notification_behavior","occurred_at","received_at"],"type":"object"},"fulfillment_event_id":{"type":"string"},"fulfillment_id":{"type":"string"},"order_id":{"type":"string"}},"required":["order_id","fulfillment_id","fulfillment_event_id","fulfillment_event"],"type":"object"},"event_type":{"const":"order.fulfillment.event.created"}}},"Webhook_order_fulfillment_package_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"},"package":{"additionalProperties":false,"properties":{"carrier":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"delivered_at":{"format":"date-time","type":"string"},"dimensions":{"additionalProperties":false,"properties":{"height":{"type":"number"},"length":{"type":"number"},"unit":{"type":"string"},"width":{"type":"number"}},"required":["length","width","height","unit"],"type":"object"},"external_reference_id":{"type":"string"},"external_system":{"type":"string"},"fulfillment_id":{"type":"string"},"label_url":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"package_id":{"type":"string"},"service_code":{"type":"string"},"shipment_id":{"type":"string"},"shipped_at":{"format":"date-time","type":"string"},"status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"status_reason":{"type":"string"},"tracking_number":{"type":"string"},"tracking_url":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"weight":{"additionalProperties":false,"properties":{"unit":{"type":"string"},"value":{"type":"number"}},"required":["value","unit"],"type":"object"}},"required":["package_id","order_id","fulfillment_id","shipment_id","status","created_at","updated_at"],"type":"object"},"package_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"shipment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"delivered_at":{"format":"date-time","type":"string"},"external_reference_id":{"type":"string"},"external_system":{"type":"string"},"fulfillment_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"shipment_id":{"type":"string"},"shipped_at":{"format":"date-time","type":"string"},"status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"updated_at":{"format":"date-time","type":"string"}},"required":["shipment_id","order_id","fulfillment_id","status","created_at","updated_at"],"type":"object"},"shipment_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["order_id","fulfillment_id","shipment_id","package_id","order","fulfillment","shipment","package","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.fulfillment.package.created"}}},"Webhook_order_fulfillment_package_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_id":{"type":"string"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"},"package":{"additionalProperties":false,"properties":{"carrier":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"delivered_at":{"format":"date-time","type":"string"},"dimensions":{"additionalProperties":false,"properties":{"height":{"type":"number"},"length":{"type":"number"},"unit":{"type":"string"},"width":{"type":"number"}},"required":["length","width","height","unit"],"type":"object"},"external_reference_id":{"type":"string"},"external_system":{"type":"string"},"fulfillment_id":{"type":"string"},"label_url":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"package_id":{"type":"string"},"service_code":{"type":"string"},"shipment_id":{"type":"string"},"shipped_at":{"format":"date-time","type":"string"},"status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"status_reason":{"type":"string"},"tracking_number":{"type":"string"},"tracking_url":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"weight":{"additionalProperties":false,"properties":{"unit":{"type":"string"},"value":{"type":"number"}},"required":["value","unit"],"type":"object"}},"required":["package_id","order_id","fulfillment_id","shipment_id","status","created_at","updated_at"],"type":"object"},"package_id":{"type":"string"},"shipment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"delivered_at":{"format":"date-time","type":"string"},"external_reference_id":{"type":"string"},"external_system":{"type":"string"},"fulfillment_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"shipment_id":{"type":"string"},"shipped_at":{"format":"date-time","type":"string"},"status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"updated_at":{"format":"date-time","type":"string"}},"required":["shipment_id","order_id","fulfillment_id","status","created_at","updated_at"],"type":"object"},"shipment_id":{"type":"string"}},"required":["order_id","fulfillment_id","shipment_id","package_id","order","fulfillment","shipment","package"],"type":"object"},"event_type":{"const":"order.fulfillment.package.created"}}},"Webhook_order_fulfillment_package_updated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"current_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_event":{"additionalProperties":false,"properties":{"buyer_notification_behavior":{"enum":["default","suppress","request"],"type":"string","x-enum-descriptions":["Default.","Suppress.","Request."],"x-flint-enum":"closed"},"custom_details":{"additionalProperties":{"type":"string"},"type":"object"},"event_type":{"enum":["accepted","preparing","picked","packed","ready","shipped","dispatched","in_transit","out_for_delivery","delivered","delivery_attempted","tracking_updated","exception","returned","completed","canceled","failed","no_show","custom"],"type":"string","x-enum-descriptions":["Accepted.","Preparing.","Picked.","Packed.","Ready.","Shipped.","Dispatched.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Tracking updated.","Exception.","Returned.","Completed.","Canceled.","Failed.","No show.","Custom."],"x-flint-enum":"closed"},"external_event_id":{"type":"string"},"external_status":{"type":"string"},"external_system":{"type":"string"},"fulfillment_event_id":{"type":"string"},"fulfillment_id":{"type":"string"},"fulfillment_status_update_id":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"package_id":{"type":"string"},"package_status_update_id":{"type":"string"},"received_at":{"format":"date-time","type":"string"},"shipment_id":{"type":"string"},"shipment_status_update_id":{"type":"string"},"target_package_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"target_quantity_effect":{"enum":["preserve","fulfill","release"],"type":"string","x-enum-descriptions":["Preserve.","Fulfill.","Release."],"x-flint-enum":"closed"},"target_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"}},"required":["fulfillment_event_id","order_id","fulfillment_id","event_type","buyer_notification_behavior","occurred_at","received_at"],"type":"object"},"fulfillment_event_id":{"type":"string"},"fulfillment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"},"package":{"additionalProperties":false,"properties":{"carrier":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"delivered_at":{"format":"date-time","type":"string"},"dimensions":{"additionalProperties":false,"properties":{"height":{"type":"number"},"length":{"type":"number"},"unit":{"type":"string"},"width":{"type":"number"}},"required":["length","width","height","unit"],"type":"object"},"external_reference_id":{"type":"string"},"external_system":{"type":"string"},"fulfillment_id":{"type":"string"},"label_url":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"package_id":{"type":"string"},"service_code":{"type":"string"},"shipment_id":{"type":"string"},"shipped_at":{"format":"date-time","type":"string"},"status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"status_reason":{"type":"string"},"tracking_number":{"type":"string"},"tracking_url":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"weight":{"additionalProperties":false,"properties":{"unit":{"type":"string"},"value":{"type":"number"}},"required":["value","unit"],"type":"object"}},"required":["package_id","order_id","fulfillment_id","shipment_id","status","created_at","updated_at"],"type":"object"},"package_id":{"type":"string"},"package_status_update":{"additionalProperties":false,"properties":{"buyer_notification_behavior":{"enum":["default","suppress","request"],"type":"string","x-enum-descriptions":["Default.","Suppress.","Request."],"x-flint-enum":"closed"},"created_at":{"format":"date-time","type":"string"},"current_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"fulfillment_id":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"package_id":{"type":"string"},"package_status_update_id":{"type":"string"},"previous_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"reason":{"type":"string"},"shipment_id":{"type":"string"}},"required":["package_status_update_id","order_id","fulfillment_id","shipment_id","package_id","previous_status","current_status","buyer_notification_behavior","occurred_at","created_at"],"type":"object"},"package_status_update_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"previous_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"shipment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"delivered_at":{"format":"date-time","type":"string"},"external_reference_id":{"type":"string"},"external_system":{"type":"string"},"fulfillment_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"shipment_id":{"type":"string"},"shipped_at":{"format":"date-time","type":"string"},"status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"updated_at":{"format":"date-time","type":"string"}},"required":["shipment_id","order_id","fulfillment_id","status","created_at","updated_at"],"type":"object"},"shipment_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["order_id","fulfillment_id","shipment_id","package_id","previous_status","current_status","package_status_update_id","order","fulfillment","shipment","package","package_status_update","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.fulfillment.package.updated"}}},"Webhook_order_fulfillment_package_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"current_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_event":{"additionalProperties":false,"properties":{"buyer_notification_behavior":{"enum":["default","suppress","request"],"type":"string","x-enum-descriptions":["Default.","Suppress.","Request."],"x-flint-enum":"closed"},"custom_details":{"additionalProperties":{"type":"string"},"type":"object"},"event_type":{"enum":["accepted","preparing","picked","packed","ready","shipped","dispatched","in_transit","out_for_delivery","delivered","delivery_attempted","tracking_updated","exception","returned","completed","canceled","failed","no_show","custom"],"type":"string","x-enum-descriptions":["Accepted.","Preparing.","Picked.","Packed.","Ready.","Shipped.","Dispatched.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Tracking updated.","Exception.","Returned.","Completed.","Canceled.","Failed.","No show.","Custom."],"x-flint-enum":"closed"},"external_event_id":{"type":"string"},"external_status":{"type":"string"},"external_system":{"type":"string"},"fulfillment_event_id":{"type":"string"},"fulfillment_id":{"type":"string"},"fulfillment_status_update_id":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"package_id":{"type":"string"},"package_status_update_id":{"type":"string"},"received_at":{"format":"date-time","type":"string"},"shipment_id":{"type":"string"},"shipment_status_update_id":{"type":"string"},"target_package_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"target_quantity_effect":{"enum":["preserve","fulfill","release"],"type":"string","x-enum-descriptions":["Preserve.","Fulfill.","Release."],"x-flint-enum":"closed"},"target_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"}},"required":["fulfillment_event_id","order_id","fulfillment_id","event_type","buyer_notification_behavior","occurred_at","received_at"],"type":"object"},"fulfillment_event_id":{"type":"string"},"fulfillment_id":{"type":"string"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"},"package":{"additionalProperties":false,"properties":{"carrier":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"delivered_at":{"format":"date-time","type":"string"},"dimensions":{"additionalProperties":false,"properties":{"height":{"type":"number"},"length":{"type":"number"},"unit":{"type":"string"},"width":{"type":"number"}},"required":["length","width","height","unit"],"type":"object"},"external_reference_id":{"type":"string"},"external_system":{"type":"string"},"fulfillment_id":{"type":"string"},"label_url":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"package_id":{"type":"string"},"service_code":{"type":"string"},"shipment_id":{"type":"string"},"shipped_at":{"format":"date-time","type":"string"},"status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"status_reason":{"type":"string"},"tracking_number":{"type":"string"},"tracking_url":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"weight":{"additionalProperties":false,"properties":{"unit":{"type":"string"},"value":{"type":"number"}},"required":["value","unit"],"type":"object"}},"required":["package_id","order_id","fulfillment_id","shipment_id","status","created_at","updated_at"],"type":"object"},"package_id":{"type":"string"},"package_status_update":{"additionalProperties":false,"properties":{"buyer_notification_behavior":{"enum":["default","suppress","request"],"type":"string","x-enum-descriptions":["Default.","Suppress.","Request."],"x-flint-enum":"closed"},"created_at":{"format":"date-time","type":"string"},"current_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"fulfillment_id":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"package_id":{"type":"string"},"package_status_update_id":{"type":"string"},"previous_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"reason":{"type":"string"},"shipment_id":{"type":"string"}},"required":["package_status_update_id","order_id","fulfillment_id","shipment_id","package_id","previous_status","current_status","buyer_notification_behavior","occurred_at","created_at"],"type":"object"},"package_status_update_id":{"type":"string"},"previous_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"shipment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"delivered_at":{"format":"date-time","type":"string"},"external_reference_id":{"type":"string"},"external_system":{"type":"string"},"fulfillment_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"shipment_id":{"type":"string"},"shipped_at":{"format":"date-time","type":"string"},"status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"updated_at":{"format":"date-time","type":"string"}},"required":["shipment_id","order_id","fulfillment_id","status","created_at","updated_at"],"type":"object"},"shipment_id":{"type":"string"}},"required":["order_id","fulfillment_id","shipment_id","package_id","previous_status","current_status","package_status_update_id","order","fulfillment","shipment","package","package_status_update"],"type":"object"},"event_type":{"const":"order.fulfillment.package.updated"}}},"Webhook_order_fulfillment_shipment_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"shipment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"delivered_at":{"format":"date-time","type":"string"},"external_reference_id":{"type":"string"},"external_system":{"type":"string"},"fulfillment_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"shipment_id":{"type":"string"},"shipped_at":{"format":"date-time","type":"string"},"status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"updated_at":{"format":"date-time","type":"string"}},"required":["shipment_id","order_id","fulfillment_id","status","created_at","updated_at"],"type":"object"},"shipment_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["order_id","fulfillment_id","shipment_id","order","fulfillment","shipment","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.fulfillment.shipment.created"}}},"Webhook_order_fulfillment_shipment_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_id":{"type":"string"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"},"shipment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"delivered_at":{"format":"date-time","type":"string"},"external_reference_id":{"type":"string"},"external_system":{"type":"string"},"fulfillment_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"shipment_id":{"type":"string"},"shipped_at":{"format":"date-time","type":"string"},"status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"updated_at":{"format":"date-time","type":"string"}},"required":["shipment_id","order_id","fulfillment_id","status","created_at","updated_at"],"type":"object"},"shipment_id":{"type":"string"}},"required":["order_id","fulfillment_id","shipment_id","order","fulfillment","shipment"],"type":"object"},"event_type":{"const":"order.fulfillment.shipment.created"}}},"Webhook_order_fulfillment_shipment_updated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"current_status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_event":{"additionalProperties":false,"properties":{"buyer_notification_behavior":{"enum":["default","suppress","request"],"type":"string","x-enum-descriptions":["Default.","Suppress.","Request."],"x-flint-enum":"closed"},"custom_details":{"additionalProperties":{"type":"string"},"type":"object"},"event_type":{"enum":["accepted","preparing","picked","packed","ready","shipped","dispatched","in_transit","out_for_delivery","delivered","delivery_attempted","tracking_updated","exception","returned","completed","canceled","failed","no_show","custom"],"type":"string","x-enum-descriptions":["Accepted.","Preparing.","Picked.","Packed.","Ready.","Shipped.","Dispatched.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Tracking updated.","Exception.","Returned.","Completed.","Canceled.","Failed.","No show.","Custom."],"x-flint-enum":"closed"},"external_event_id":{"type":"string"},"external_status":{"type":"string"},"external_system":{"type":"string"},"fulfillment_event_id":{"type":"string"},"fulfillment_id":{"type":"string"},"fulfillment_status_update_id":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"package_id":{"type":"string"},"package_status_update_id":{"type":"string"},"received_at":{"format":"date-time","type":"string"},"shipment_id":{"type":"string"},"shipment_status_update_id":{"type":"string"},"target_package_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"target_quantity_effect":{"enum":["preserve","fulfill","release"],"type":"string","x-enum-descriptions":["Preserve.","Fulfill.","Release."],"x-flint-enum":"closed"},"target_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"}},"required":["fulfillment_event_id","order_id","fulfillment_id","event_type","buyer_notification_behavior","occurred_at","received_at"],"type":"object"},"fulfillment_event_id":{"type":"string"},"fulfillment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"previous_status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"shipment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"delivered_at":{"format":"date-time","type":"string"},"external_reference_id":{"type":"string"},"external_system":{"type":"string"},"fulfillment_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"shipment_id":{"type":"string"},"shipped_at":{"format":"date-time","type":"string"},"status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"updated_at":{"format":"date-time","type":"string"}},"required":["shipment_id","order_id","fulfillment_id","status","created_at","updated_at"],"type":"object"},"shipment_id":{"type":"string"},"shipment_status_update":{"additionalProperties":false,"properties":{"buyer_notification_behavior":{"enum":["default","suppress","request"],"type":"string","x-enum-descriptions":["Default.","Suppress.","Request."],"x-flint-enum":"closed"},"created_at":{"format":"date-time","type":"string"},"current_status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"fulfillment_id":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"previous_status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"reason":{"type":"string"},"shipment_id":{"type":"string"},"shipment_status_update_id":{"type":"string"}},"required":["shipment_status_update_id","order_id","fulfillment_id","shipment_id","previous_status","current_status","buyer_notification_behavior","occurred_at","created_at"],"type":"object"},"shipment_status_update_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["order_id","fulfillment_id","shipment_id","previous_status","current_status","shipment_status_update_id","order","fulfillment","shipment","shipment_status_update","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.fulfillment.shipment.updated"}}},"Webhook_order_fulfillment_shipment_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"current_status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_event":{"additionalProperties":false,"properties":{"buyer_notification_behavior":{"enum":["default","suppress","request"],"type":"string","x-enum-descriptions":["Default.","Suppress.","Request."],"x-flint-enum":"closed"},"custom_details":{"additionalProperties":{"type":"string"},"type":"object"},"event_type":{"enum":["accepted","preparing","picked","packed","ready","shipped","dispatched","in_transit","out_for_delivery","delivered","delivery_attempted","tracking_updated","exception","returned","completed","canceled","failed","no_show","custom"],"type":"string","x-enum-descriptions":["Accepted.","Preparing.","Picked.","Packed.","Ready.","Shipped.","Dispatched.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Tracking updated.","Exception.","Returned.","Completed.","Canceled.","Failed.","No show.","Custom."],"x-flint-enum":"closed"},"external_event_id":{"type":"string"},"external_status":{"type":"string"},"external_system":{"type":"string"},"fulfillment_event_id":{"type":"string"},"fulfillment_id":{"type":"string"},"fulfillment_status_update_id":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"package_id":{"type":"string"},"package_status_update_id":{"type":"string"},"received_at":{"format":"date-time","type":"string"},"shipment_id":{"type":"string"},"shipment_status_update_id":{"type":"string"},"target_package_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"target_quantity_effect":{"enum":["preserve","fulfill","release"],"type":"string","x-enum-descriptions":["Preserve.","Fulfill.","Release."],"x-flint-enum":"closed"},"target_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"}},"required":["fulfillment_event_id","order_id","fulfillment_id","event_type","buyer_notification_behavior","occurred_at","received_at"],"type":"object"},"fulfillment_event_id":{"type":"string"},"fulfillment_id":{"type":"string"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"},"previous_status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"shipment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"delivered_at":{"format":"date-time","type":"string"},"external_reference_id":{"type":"string"},"external_system":{"type":"string"},"fulfillment_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"shipment_id":{"type":"string"},"shipped_at":{"format":"date-time","type":"string"},"status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"updated_at":{"format":"date-time","type":"string"}},"required":["shipment_id","order_id","fulfillment_id","status","created_at","updated_at"],"type":"object"},"shipment_id":{"type":"string"},"shipment_status_update":{"additionalProperties":false,"properties":{"buyer_notification_behavior":{"enum":["default","suppress","request"],"type":"string","x-enum-descriptions":["Default.","Suppress.","Request."],"x-flint-enum":"closed"},"created_at":{"format":"date-time","type":"string"},"current_status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"fulfillment_id":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"previous_status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"reason":{"type":"string"},"shipment_id":{"type":"string"},"shipment_status_update_id":{"type":"string"}},"required":["shipment_status_update_id","order_id","fulfillment_id","shipment_id","previous_status","current_status","buyer_notification_behavior","occurred_at","created_at"],"type":"object"},"shipment_status_update_id":{"type":"string"}},"required":["order_id","fulfillment_id","shipment_id","previous_status","current_status","shipment_status_update_id","order","fulfillment","shipment","shipment_status_update"],"type":"object"},"event_type":{"const":"order.fulfillment.shipment.updated"}}},"Webhook_order_fulfillment_status_changed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"current_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_id":{"type":"string"},"fulfillment_status_update":{"additionalProperties":false,"properties":{"buyer_notification_behavior":{"enum":["default","suppress","request"],"type":"string","x-enum-descriptions":["Default.","Suppress.","Request."],"x-flint-enum":"closed"},"created_at":{"format":"date-time","type":"string"},"current_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"},"fulfillment_id":{"type":"string"},"fulfillment_status_update_id":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"previous_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"},"quantity_effect":{"enum":["preserve","fulfill","release"],"type":"string","x-enum-descriptions":["Preserve.","Fulfill.","Release."],"x-flint-enum":"closed"},"reason":{"type":"string"}},"required":["fulfillment_status_update_id","order_id","fulfillment_id","previous_status","current_status","quantity_effect","buyer_notification_behavior","occurred_at","created_at"],"type":"object"},"fulfillment_status_update_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"previous_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"},"source_type":{"const":"installed_merchants"}},"required":["order_id","fulfillment_id","previous_status","current_status","fulfillment_status_update_id","order","fulfillment","fulfillment_status_update","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.fulfillment.status_changed"}}},"Webhook_order_fulfillment_status_changed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"current_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"},"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_id":{"type":"string"},"fulfillment_status_update":{"additionalProperties":false,"properties":{"buyer_notification_behavior":{"enum":["default","suppress","request"],"type":"string","x-enum-descriptions":["Default.","Suppress.","Request."],"x-flint-enum":"closed"},"created_at":{"format":"date-time","type":"string"},"current_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"},"fulfillment_id":{"type":"string"},"fulfillment_status_update_id":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"previous_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"},"quantity_effect":{"enum":["preserve","fulfill","release"],"type":"string","x-enum-descriptions":["Preserve.","Fulfill.","Release."],"x-flint-enum":"closed"},"reason":{"type":"string"}},"required":["fulfillment_status_update_id","order_id","fulfillment_id","previous_status","current_status","quantity_effect","buyer_notification_behavior","occurred_at","created_at"],"type":"object"},"fulfillment_status_update_id":{"type":"string"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"},"previous_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"}},"required":["order_id","fulfillment_id","previous_status","current_status","fulfillment_status_update_id","order","fulfillment","fulfillment_status_update"],"type":"object"},"event_type":{"const":"order.fulfillment.status_changed"}}},"Webhook_order_fulfillment_updated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["order_id","fulfillment_id","order","fulfillment","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.fulfillment.updated"}}},"Webhook_order_fulfillment_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_id":{"type":"string"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"}},"required":["order_id","fulfillment_id","order","fulfillment"],"type":"object"},"event_type":{"const":"order.fulfillment.updated"}}},"Webhook_order_inventory_action_required_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"order_id":{"type":"string"}},"required":["order_id"],"type":"object"},"event_type":{"const":"order.inventory_action_required"}}},"Webhook_order_inventory_exception_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"customer_id":{"type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"inventory_exception_reason":{"enum":["inventory_deduction_failed","auto_refund_required","auto_refund_failed","policy_resolution_failed","fulfillment_handoff_failed"],"type":"string","x-enum-descriptions":["Inventory deduction failed.","Auto refund required.","Auto refund failed.","Policy resolution failed.","Fulfillment handoff failed."],"x-flint-enum":"closed"},"inventory_exception_status":{"enum":["paid_inventory_failed"],"type":"string","x-enum-descriptions":["Paid inventory failed."],"x-flint-enum":"open"},"inventory_exception_updated_at":{"format":"date-time","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"order_number":{"type":"string"},"partner_app_install_id":{"type":"string"},"payment_status":{"enum":["unpaid","partially_paid","paid"],"type":"string","x-enum-descriptions":["Unpaid.","Partially paid.","Paid."],"x-flint-enum":"open"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id","status","payment_status","refund_status","resource_updated_at","inventory_exception_status","inventory_exception_updated_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.inventory_exception.created"}}},"Webhook_order_inventory_exception_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"customer_id":{"type":"string"},"inventory_exception_reason":{"enum":["inventory_deduction_failed","auto_refund_required","auto_refund_failed","policy_resolution_failed","fulfillment_handoff_failed"],"type":"string","x-enum-descriptions":["Inventory deduction failed.","Auto refund required.","Auto refund failed.","Policy resolution failed.","Fulfillment handoff failed."],"x-flint-enum":"closed"},"inventory_exception_status":{"enum":["paid_inventory_failed"],"type":"string","x-enum-descriptions":["Paid inventory failed."],"x-flint-enum":"open"},"inventory_exception_updated_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"order_number":{"type":"string"},"payment_status":{"enum":["unpaid","partially_paid","paid"],"type":"string","x-enum-descriptions":["Unpaid.","Partially paid.","Paid."],"x-flint-enum":"open"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id","status","payment_status","refund_status","resource_updated_at","inventory_exception_status","inventory_exception_updated_at"],"type":"object"},"event_type":{"const":"order.inventory_exception.created"}}},"Webhook_order_inventory_exception_resolved_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"customer_id":{"type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"inventory_exception_reason":{"enum":["order_fully_refunded","resolved_by_admin"],"type":"string","x-enum-descriptions":["Order fully refunded.","Resolved by admin."],"x-flint-enum":"closed"},"inventory_exception_status":{"enum":["resolved"],"type":"string","x-enum-descriptions":["Resolved."],"x-flint-enum":"open"},"inventory_exception_updated_at":{"format":"date-time","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"order_number":{"type":"string"},"partner_app_install_id":{"type":"string"},"payment_status":{"enum":["unpaid","partially_paid","paid"],"type":"string","x-enum-descriptions":["Unpaid.","Partially paid.","Paid."],"x-flint-enum":"open"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id","status","payment_status","refund_status","resource_updated_at","inventory_exception_status","inventory_exception_updated_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.inventory_exception.resolved"}}},"Webhook_order_inventory_exception_resolved_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"customer_id":{"type":"string"},"inventory_exception_reason":{"enum":["order_fully_refunded","resolved_by_admin"],"type":"string","x-enum-descriptions":["Order fully refunded.","Resolved by admin."],"x-flint-enum":"closed"},"inventory_exception_status":{"enum":["resolved"],"type":"string","x-enum-descriptions":["Resolved."],"x-flint-enum":"open"},"inventory_exception_updated_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"order_number":{"type":"string"},"payment_status":{"enum":["unpaid","partially_paid","paid"],"type":"string","x-enum-descriptions":["Unpaid.","Partially paid.","Paid."],"x-flint-enum":"open"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id","status","payment_status","refund_status","resource_updated_at","inventory_exception_status","inventory_exception_updated_at"],"type":"object"},"event_type":{"const":"order.inventory_exception.resolved"}}},"Webhook_order_paid_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"line_items":{"items":{"additionalProperties":false,"properties":{"base_subtotal_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"bundle_components":{"items":{"additionalProperties":false,"properties":{"component_snapshot_id":{"type":"string"},"position":{"type":"integer"},"product_id":{"type":"string"},"quantity":{"type":"integer"},"total_quantity":{"type":"integer"},"variant_id":{"type":"string"}},"required":["variant_id","product_id","quantity","position"],"type":"object"},"type":"array"},"bundle_id":{"type":"string"},"categories":{"items":{"additionalProperties":false,"properties":{"category_id":{"type":"string"},"handle":{"type":"string"},"name":{"type":"string"}},"required":["handle","name"],"type":"object"},"type":"array"},"discount_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"modifier_total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"modifiers":{"items":{"additionalProperties":false,"properties":{"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"modifier_group_name":{"type":"string"},"name":{"type":"string"},"order_line_item_modifier_id":{"type":"string"},"quantity":{"type":"integer"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"source_type":{"enum":["catalog_modifier","text"],"type":"string","x-enum-descriptions":["Catalog modifier.","Text."],"x-flint-enum":"closed"},"text_value":{"type":"string"},"total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"unit_price_delta_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"}},"required":["order_line_item_modifier_id","source_type","modifier_group_name","name","quantity","show_on_receipt","show_on_fulfillment"],"type":"object"},"type":"array"},"name":{"type":"string"},"order_line_item_id":{"type":"string"},"product_id":{"type":"string"},"quantity":{"type":"integer"},"selected_options":{"items":{"additionalProperties":false,"properties":{"option_id":{"type":"string"},"option_name":{"type":"string"},"option_value_id":{"type":"string"},"value":{"type":"string"}},"required":["option_id","option_name","option_value_id","value"],"type":"object"},"type":"array"},"source_type":{"enum":["variant","bundle"],"type":"string","x-enum-descriptions":["Variant.","Bundle."],"x-flint-enum":"closed"},"subtotal_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"tax_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"unit_price_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"variant_id":{"type":"string"}},"required":["order_line_item_id","name","quantity"],"type":"object"},"type":"array"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"order_payment_intent_ids":{"items":{"type":"string"},"type":"array"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"paid_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"partner_app_install_id":{"type":"string"},"payment_status":{"enum":["paid"],"type":"string","x-enum-descriptions":["Paid."],"x-flint-enum":"open"},"source_type":{"const":"installed_merchants"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"},"total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"}},"required":["order_id","status","payment_status","total_money","paid_money","outstanding_money","order_payment_intent_ids","line_items","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.paid"}}},"Webhook_order_paid_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"line_items":{"items":{"additionalProperties":false,"properties":{"base_subtotal_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"bundle_components":{"items":{"additionalProperties":false,"properties":{"component_snapshot_id":{"type":"string"},"position":{"type":"integer"},"product_id":{"type":"string"},"quantity":{"type":"integer"},"total_quantity":{"type":"integer"},"variant_id":{"type":"string"}},"required":["variant_id","product_id","quantity","position"],"type":"object"},"type":"array"},"bundle_id":{"type":"string"},"categories":{"items":{"additionalProperties":false,"properties":{"category_id":{"type":"string"},"handle":{"type":"string"},"name":{"type":"string"}},"required":["handle","name"],"type":"object"},"type":"array"},"discount_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"modifier_total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"modifiers":{"items":{"additionalProperties":false,"properties":{"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"modifier_group_name":{"type":"string"},"name":{"type":"string"},"order_line_item_modifier_id":{"type":"string"},"quantity":{"type":"integer"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"source_type":{"enum":["catalog_modifier","text"],"type":"string","x-enum-descriptions":["Catalog modifier.","Text."],"x-flint-enum":"closed"},"text_value":{"type":"string"},"total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"unit_price_delta_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"}},"required":["order_line_item_modifier_id","source_type","modifier_group_name","name","quantity","show_on_receipt","show_on_fulfillment"],"type":"object"},"type":"array"},"name":{"type":"string"},"order_line_item_id":{"type":"string"},"product_id":{"type":"string"},"quantity":{"type":"integer"},"selected_options":{"items":{"additionalProperties":false,"properties":{"option_id":{"type":"string"},"option_name":{"type":"string"},"option_value_id":{"type":"string"},"value":{"type":"string"}},"required":["option_id","option_name","option_value_id","value"],"type":"object"},"type":"array"},"source_type":{"enum":["variant","bundle"],"type":"string","x-enum-descriptions":["Variant.","Bundle."],"x-flint-enum":"closed"},"subtotal_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"tax_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"unit_price_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"variant_id":{"type":"string"}},"required":["order_line_item_id","name","quantity"],"type":"object"},"type":"array"},"order_id":{"type":"string"},"order_payment_intent_ids":{"items":{"type":"string"},"type":"array"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"paid_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"payment_status":{"enum":["paid"],"type":"string","x-enum-descriptions":["Paid."],"x-flint-enum":"open"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"},"total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"}},"required":["order_id","status","payment_status","total_money","paid_money","outstanding_money","order_payment_intent_ids","line_items"],"type":"object"},"event_type":{"const":"order.paid"}}},"Webhook_order_partially_paid_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"line_items":{"items":{"additionalProperties":false,"properties":{"base_subtotal_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"bundle_components":{"items":{"additionalProperties":false,"properties":{"component_snapshot_id":{"type":"string"},"position":{"type":"integer"},"product_id":{"type":"string"},"quantity":{"type":"integer"},"total_quantity":{"type":"integer"},"variant_id":{"type":"string"}},"required":["variant_id","product_id","quantity","position"],"type":"object"},"type":"array"},"bundle_id":{"type":"string"},"categories":{"items":{"additionalProperties":false,"properties":{"category_id":{"type":"string"},"handle":{"type":"string"},"name":{"type":"string"}},"required":["handle","name"],"type":"object"},"type":"array"},"discount_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"modifier_total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"modifiers":{"items":{"additionalProperties":false,"properties":{"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"modifier_group_name":{"type":"string"},"name":{"type":"string"},"order_line_item_modifier_id":{"type":"string"},"quantity":{"type":"integer"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"source_type":{"enum":["catalog_modifier","text"],"type":"string","x-enum-descriptions":["Catalog modifier.","Text."],"x-flint-enum":"closed"},"text_value":{"type":"string"},"total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"unit_price_delta_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"}},"required":["order_line_item_modifier_id","source_type","modifier_group_name","name","quantity","show_on_receipt","show_on_fulfillment"],"type":"object"},"type":"array"},"name":{"type":"string"},"order_line_item_id":{"type":"string"},"product_id":{"type":"string"},"quantity":{"type":"integer"},"selected_options":{"items":{"additionalProperties":false,"properties":{"option_id":{"type":"string"},"option_name":{"type":"string"},"option_value_id":{"type":"string"},"value":{"type":"string"}},"required":["option_id","option_name","option_value_id","value"],"type":"object"},"type":"array"},"source_type":{"enum":["variant","bundle"],"type":"string","x-enum-descriptions":["Variant.","Bundle."],"x-flint-enum":"closed"},"subtotal_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"tax_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"unit_price_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"variant_id":{"type":"string"}},"required":["order_line_item_id","name","quantity"],"type":"object"},"type":"array"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"order_payment_intent_ids":{"items":{"type":"string"},"type":"array"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"paid_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"partner_app_install_id":{"type":"string"},"payment_status":{"enum":["partially_paid"],"type":"string","x-enum-descriptions":["Partially paid."],"x-flint-enum":"open"},"source_type":{"const":"installed_merchants"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"},"total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"}},"required":["order_id","status","payment_status","total_money","paid_money","outstanding_money","order_payment_intent_ids","line_items","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.partially_paid"}}},"Webhook_order_partially_paid_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"line_items":{"items":{"additionalProperties":false,"properties":{"base_subtotal_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"bundle_components":{"items":{"additionalProperties":false,"properties":{"component_snapshot_id":{"type":"string"},"position":{"type":"integer"},"product_id":{"type":"string"},"quantity":{"type":"integer"},"total_quantity":{"type":"integer"},"variant_id":{"type":"string"}},"required":["variant_id","product_id","quantity","position"],"type":"object"},"type":"array"},"bundle_id":{"type":"string"},"categories":{"items":{"additionalProperties":false,"properties":{"category_id":{"type":"string"},"handle":{"type":"string"},"name":{"type":"string"}},"required":["handle","name"],"type":"object"},"type":"array"},"discount_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"modifier_total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"modifiers":{"items":{"additionalProperties":false,"properties":{"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"modifier_group_name":{"type":"string"},"name":{"type":"string"},"order_line_item_modifier_id":{"type":"string"},"quantity":{"type":"integer"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"source_type":{"enum":["catalog_modifier","text"],"type":"string","x-enum-descriptions":["Catalog modifier.","Text."],"x-flint-enum":"closed"},"text_value":{"type":"string"},"total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"unit_price_delta_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"}},"required":["order_line_item_modifier_id","source_type","modifier_group_name","name","quantity","show_on_receipt","show_on_fulfillment"],"type":"object"},"type":"array"},"name":{"type":"string"},"order_line_item_id":{"type":"string"},"product_id":{"type":"string"},"quantity":{"type":"integer"},"selected_options":{"items":{"additionalProperties":false,"properties":{"option_id":{"type":"string"},"option_name":{"type":"string"},"option_value_id":{"type":"string"},"value":{"type":"string"}},"required":["option_id","option_name","option_value_id","value"],"type":"object"},"type":"array"},"source_type":{"enum":["variant","bundle"],"type":"string","x-enum-descriptions":["Variant.","Bundle."],"x-flint-enum":"closed"},"subtotal_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"tax_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"unit_price_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"variant_id":{"type":"string"}},"required":["order_line_item_id","name","quantity"],"type":"object"},"type":"array"},"order_id":{"type":"string"},"order_payment_intent_ids":{"items":{"type":"string"},"type":"array"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"paid_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"payment_status":{"enum":["partially_paid"],"type":"string","x-enum-descriptions":["Partially paid."],"x-flint-enum":"open"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"},"total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"}},"required":["order_id","status","payment_status","total_money","paid_money","outstanding_money","order_payment_intent_ids","line_items"],"type":"object"},"event_type":{"const":"order.partially_paid"}}},"Webhook_order_payment_authorization_canceled_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["order_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.payment_authorization_canceled"}}},"Webhook_order_payment_authorization_canceled_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"order_id":{"type":"string"}},"required":["order_id"],"type":"object"},"event_type":{"const":"order.payment_authorization_canceled"}}},"Webhook_order_payment_authorization_expired_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["order_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.payment_authorization_expired"}}},"Webhook_order_payment_authorization_expired_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"order_id":{"type":"string"}},"required":["order_id"],"type":"object"},"event_type":{"const":"order.payment_authorization_expired"}}},"Webhook_order_payment_authorized_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["order_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.payment_authorized"}}},"Webhook_order_payment_authorized_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"order_id":{"type":"string"}},"required":["order_id"],"type":"object"},"event_type":{"const":"order.payment_authorized"}}},"Webhook_order_payment_captured_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["order_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.payment_captured"}}},"Webhook_order_payment_captured_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"order_id":{"type":"string"}},"required":["order_id"],"type":"object"},"event_type":{"const":"order.payment_captured"}}},"Webhook_order_refunded_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["order_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.refunded"}}},"Webhook_order_refunded_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"order_id":{"type":"string"}},"required":["order_id"],"type":"object"},"event_type":{"const":"order.refunded"}}},"Webhook_order_updated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"customer_id":{"type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"order_number":{"type":"string"},"partner_app_install_id":{"type":"string"},"payment_status":{"enum":["unpaid","partially_paid","paid"],"type":"string","x-enum-descriptions":["Unpaid.","Partially paid.","Paid."],"x-flint-enum":"open"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id","status","payment_status","refund_status","resource_updated_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"order.updated"}}},"Webhook_order_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"customer_id":{"type":"string"},"order_id":{"type":"string"},"order_number":{"type":"string"},"payment_status":{"enum":["unpaid","partially_paid","paid"],"type":"string","x-enum-descriptions":["Unpaid.","Partially paid.","Paid."],"x-flint-enum":"open"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id","status","payment_status","refund_status","resource_updated_at"],"type":"object"},"event_type":{"const":"order.updated"}}},"Webhook_partner_app_install_created_partner_app":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/PartnerInstallEventPayload"},"event_type":{"const":"partner_app.install.created"}}},"Webhook_partner_app_install_environment_grant_created_partner_app":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/PartnerEnvironmentGrantEventPayload"},"event_type":{"const":"partner_app.install.environment_grant.created"}}},"Webhook_partner_app_install_environment_grant_revoked_partner_app":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/PartnerEnvironmentGrantEventPayload"},"event_type":{"const":"partner_app.install.environment_grant.revoked"}}},"Webhook_partner_app_install_permissions_updated_partner_app":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/PartnerInstallEventPayload"},"event_type":{"const":"partner_app.install.permissions_updated"}}},"Webhook_partner_app_install_revoked_partner_app":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/PartnerInstallEventPayload"},"event_type":{"const":"partner_app.install.revoked"}}},"Webhook_partner_app_install_updated_partner_app":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/PartnerInstallEventPayload"},"event_type":{"const":"partner_app.install.updated"}}},"Webhook_payment_intent_canceled_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"payment_intent_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["payment_intent_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"payment_intent.canceled"}}},"Webhook_payment_intent_canceled_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"payment_intent_id":{"type":"string"}},"required":["payment_intent_id"],"type":"object"},"event_type":{"const":"payment_intent.canceled"}}},"Webhook_payment_intent_fulfillment_hold_updated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"fulfillment_hold":{"additionalProperties":false,"properties":{"reason":{"enum":["external_payment_hold","external_payment_hold_released"],"type":"string","x-enum-descriptions":["External payment hold.","External payment hold released."],"x-flint-enum":"closed"},"released_at":{"format":"date-time","type":"string"},"requested_at":{"format":"date-time","type":"string"},"required_action":{"enum":["pause_fulfillment","reevaluate_fulfillment"],"type":"string","x-enum-descriptions":["Pause fulfillment.","Reevaluate fulfillment."],"x-flint-enum":"closed"},"status":{"enum":["active","released"],"type":"string","x-enum-descriptions":["Active.","Released."],"x-flint-enum":"open"},"updated_at":{"format":"date-time","type":"string"}},"required":["status","reason","requested_at","updated_at","required_action"],"type":"object"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"object":{"enum":["payment_intent"],"type":"string","x-enum-descriptions":["Payment intent."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"payment_intent_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["payment_intent_id","fulfillment_hold","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"payment_intent.fulfillment_hold.updated"}}},"Webhook_payment_intent_fulfillment_hold_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"fulfillment_hold":{"additionalProperties":false,"properties":{"reason":{"enum":["external_payment_hold","external_payment_hold_released"],"type":"string","x-enum-descriptions":["External payment hold.","External payment hold released."],"x-flint-enum":"closed"},"released_at":{"format":"date-time","type":"string"},"requested_at":{"format":"date-time","type":"string"},"required_action":{"enum":["pause_fulfillment","reevaluate_fulfillment"],"type":"string","x-enum-descriptions":["Pause fulfillment.","Reevaluate fulfillment."],"x-flint-enum":"closed"},"status":{"enum":["active","released"],"type":"string","x-enum-descriptions":["Active.","Released."],"x-flint-enum":"open"},"updated_at":{"format":"date-time","type":"string"}},"required":["status","reason","requested_at","updated_at","required_action"],"type":"object"},"object":{"enum":["payment_intent"],"type":"string","x-enum-descriptions":["Payment intent."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"payment_intent_id":{"type":"string"}},"required":["payment_intent_id","fulfillment_hold"],"type":"object"},"event_type":{"const":"payment_intent.fulfillment_hold.updated"}}},"Webhook_payment_intent_payment_failed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"payment_intent_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["payment_intent_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"payment_intent.payment_failed"}}},"Webhook_payment_intent_payment_failed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"payment_intent_id":{"type":"string"}},"required":["payment_intent_id"],"type":"object"},"event_type":{"const":"payment_intent.payment_failed"}}},"Webhook_payment_intent_processing_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"payment_intent_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["payment_intent_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"payment_intent.processing"}}},"Webhook_payment_intent_processing_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"payment_intent_id":{"type":"string"}},"required":["payment_intent_id"],"type":"object"},"event_type":{"const":"payment_intent.processing"}}},"Webhook_payment_intent_requires_action_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"payment_intent_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["payment_intent_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"payment_intent.requires_action"}}},"Webhook_payment_intent_requires_action_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"payment_intent_id":{"type":"string"}},"required":["payment_intent_id"],"type":"object"},"event_type":{"const":"payment_intent.requires_action"}}},"Webhook_payment_intent_requires_capture_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"payment_intent_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["payment_intent_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"payment_intent.requires_capture"}}},"Webhook_payment_intent_requires_capture_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"payment_intent_id":{"type":"string"}},"required":["payment_intent_id"],"type":"object"},"event_type":{"const":"payment_intent.requires_capture"}}},"Webhook_payment_intent_succeeded_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"payment_intent_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["payment_intent_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"payment_intent.succeeded"}}},"Webhook_payment_intent_succeeded_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"payment_intent_id":{"type":"string"}},"required":["payment_intent_id"],"type":"object"},"event_type":{"const":"payment_intent.succeeded"}}},"Webhook_payment_method_failed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"customer_id":{"type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"failure_code":{"enum":["card_declined","insufficient_funds","bank_account_closed","bank_account_not_found","bank_debit_not_authorized","bank_account_restricted","bank_debit_limit_exceeded","authentication_required","payment_blocked","expired_card","incorrect_cvc","processing_error","payment_method_unavailable","payment_method_declined","payment_not_completed","payment_action_expired","payment_method_temporarily_unavailable","payment_failed"],"type":"string","x-enum-descriptions":["Card declined.","Insufficient funds.","Bank account closed.","Bank account not found.","Bank debit not authorized.","Bank account restricted.","Bank debit limit exceeded.","Authentication required.","Payment blocked.","Expired card.","Incorrect cvc.","Processing error.","Payment method unavailable.","Payment method declined.","Payment not completed.","Payment action expired.","Payment method temporarily unavailable.","Payment failed."],"x-flint-enum":"closed"},"failure_message":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"payment_method_id":{"type":"string"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["failed"],"type":"string","x-enum-descriptions":["Failed."],"x-flint-enum":"open"}},"required":["payment_method_id","status","resource_updated_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"payment_method.failed"}}},"Webhook_payment_method_failed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"customer_id":{"type":"string"},"failure_code":{"enum":["card_declined","insufficient_funds","bank_account_closed","bank_account_not_found","bank_debit_not_authorized","bank_account_restricted","bank_debit_limit_exceeded","authentication_required","payment_blocked","expired_card","incorrect_cvc","processing_error","payment_method_unavailable","payment_method_declined","payment_not_completed","payment_action_expired","payment_method_temporarily_unavailable","payment_failed"],"type":"string","x-enum-descriptions":["Card declined.","Insufficient funds.","Bank account closed.","Bank account not found.","Bank debit not authorized.","Bank account restricted.","Bank debit limit exceeded.","Authentication required.","Payment blocked.","Expired card.","Incorrect cvc.","Processing error.","Payment method unavailable.","Payment method declined.","Payment not completed.","Payment action expired.","Payment method temporarily unavailable.","Payment failed."],"x-flint-enum":"closed"},"failure_message":{"type":"string"},"payment_method_id":{"type":"string"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["failed"],"type":"string","x-enum-descriptions":["Failed."],"x-flint-enum":"open"}},"required":["payment_method_id","status","resource_updated_at"],"type":"object"},"event_type":{"const":"payment_method.failed"}}},"Webhook_payment_method_removed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"payment_method_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["payment_method_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"payment_method.removed"}}},"Webhook_payment_method_removed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"payment_method_id":{"type":"string"}},"required":["payment_method_id"],"type":"object"},"event_type":{"const":"payment_method.removed"}}},"Webhook_payment_method_saved_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"card_brand":{"enum":["visa","mastercard","amex","discover","diners","jcb","unionpay"],"type":"string","x-enum-descriptions":["Visa.","Mastercard.","Amex.","Discover.","Diners.","Jcb.","Unionpay."],"x-flint-enum":"closed"},"card_exp_month":{"maximum":12,"minimum":1,"type":"integer"},"card_exp_year":{"type":"integer"},"card_last4":{"type":"string"},"card_wallet":{"enum":["apple_pay","google_pay"],"type":"string","x-enum-descriptions":["Apple pay.","Google pay."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"payment_method_id":{"type":"string"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["active"],"type":"string","x-enum-descriptions":["Active."],"x-flint-enum":"open"}},"required":["payment_method_id","status","resource_updated_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"payment_method.saved"}}},"Webhook_payment_method_saved_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"card_brand":{"enum":["visa","mastercard","amex","discover","diners","jcb","unionpay"],"type":"string","x-enum-descriptions":["Visa.","Mastercard.","Amex.","Discover.","Diners.","Jcb.","Unionpay."],"x-flint-enum":"closed"},"card_exp_month":{"maximum":12,"minimum":1,"type":"integer"},"card_exp_year":{"type":"integer"},"card_last4":{"type":"string"},"card_wallet":{"enum":["apple_pay","google_pay"],"type":"string","x-enum-descriptions":["Apple pay.","Google pay."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"payment_method_id":{"type":"string"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["active"],"type":"string","x-enum-descriptions":["Active."],"x-flint-enum":"open"}},"required":["payment_method_id","status","resource_updated_at"],"type":"object"},"event_type":{"const":"payment_method.saved"}}},"Webhook_payout_canceled_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"payout_id":{"type":"string"}},"required":["payout_id"],"type":"object"},"event_type":{"const":"payout.canceled"}}},"Webhook_payout_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"payout_id":{"type":"string"}},"required":["payout_id"],"type":"object"},"event_type":{"const":"payout.created"}}},"Webhook_payout_destination_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"payout_destination_id":{"type":"string"}},"required":["payout_destination_id"],"type":"object"},"event_type":{"const":"payout_destination.created"}}},"Webhook_payout_destination_deleted_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"payout_destination_id":{"type":"string"}},"required":["payout_destination_id"],"type":"object"},"event_type":{"const":"payout_destination.deleted"}}},"Webhook_payout_destination_disabled_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"payout_destination_id":{"type":"string"}},"required":["payout_destination_id"],"type":"object"},"event_type":{"const":"payout_destination.disabled"}}},"Webhook_payout_destination_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"payout_destination_id":{"type":"string"}},"required":["payout_destination_id"],"type":"object"},"event_type":{"const":"payout_destination.updated"}}},"Webhook_payout_failed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"payout_id":{"type":"string"}},"required":["payout_id"],"type":"object"},"event_type":{"const":"payout.failed"}}},"Webhook_payout_paid_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"payout_id":{"type":"string"}},"required":["payout_id"],"type":"object"},"event_type":{"const":"payout.paid"}}},"Webhook_payout_reversed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"payout_id":{"type":"string"}},"required":["payout_id"],"type":"object"},"event_type":{"const":"payout.reversed"}}},"Webhook_payout_settings_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"payout_settings_id":{"type":"string"}},"required":["payout_settings_id"],"type":"object"},"event_type":{"const":"payout_settings.updated"}}},"Webhook_payout_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"payout_id":{"type":"string"}},"required":["payout_id"],"type":"object"},"event_type":{"const":"payout.updated"}}},"Webhook_refund_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"refund_id":{"type":"string"},"return_id":{"type":"string"},"return_resolution_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["refund_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"refund.created"}}},"Webhook_refund_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"refund_id":{"type":"string"},"return_id":{"type":"string"},"return_resolution_id":{"type":"string"}},"required":["refund_id"],"type":"object"},"event_type":{"const":"refund.created"}}},"Webhook_refund_failed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"refund_id":{"type":"string"},"return_id":{"type":"string"},"return_resolution_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["refund_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"refund.failed"}}},"Webhook_refund_failed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"refund_id":{"type":"string"},"return_id":{"type":"string"},"return_resolution_id":{"type":"string"}},"required":["refund_id"],"type":"object"},"event_type":{"const":"refund.failed"}}},"Webhook_refund_updated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"refund_id":{"type":"string"},"return_id":{"type":"string"},"return_resolution_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["refund_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"refund.updated"}}},"Webhook_refund_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"refund_id":{"type":"string"},"return_id":{"type":"string"},"return_resolution_id":{"type":"string"}},"required":["refund_id"],"type":"object"},"event_type":{"const":"refund.updated"}}},"Webhook_report_failed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"oneOf":[{"not":{"anyOf":[{"required":["download"]},{"required":["failure_reason"]}]},"properties":{"status":{"enum":["pending"],"type":"string","x-enum-descriptions":["Pending."],"x-flint-enum":"open"}}},{"not":{"required":["failure_reason"]},"properties":{"status":{"enum":["succeeded"],"type":"string","x-enum-descriptions":["Succeeded."],"x-flint-enum":"open"}},"required":["download"]},{"not":{"required":["download"]},"properties":{"status":{"enum":["failed"],"type":"string","x-enum-descriptions":["Failed."],"x-flint-enum":"open"}},"required":["failure_reason"]}],"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"currency":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","readOnly":true,"type":"string"},"download":{"$ref":"#/components/schemas/PublicDownload","readOnly":true},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"failure_reason":{"enum":["generation_failed","data_unavailable","limit_exceeded"],"readOnly":true,"type":"string","x-enum-descriptions":["Generation failed.","Data unavailable.","Limit exceeded."],"x-flint-enum":"closed"},"interval_end_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"interval_start_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"report_id":{"pattern":"^rep_[0-9A-HJKMNP-TV-Z]{26}$","readOnly":true,"type":"string"},"report_type":{"description":"The generated report contract. tax_transactions_itemized_v1 contains frozen Quaderno-backed collection and successful refund evidence for reconciliation and import, not filing instructions.","enum":["orders_itemized_v1","payments_itemized_v1","balance_transactions_itemized_v1","payouts_itemized_v1","tax_itemized_v1","tax_summarized_v1","merchant_billing_itemized_v1","tax_transactions_itemized_v1"],"readOnly":true,"type":"string","x-enum-descriptions":["Orders itemized v1.","Payments itemized v1.","Balance transactions itemized v1.","Payouts itemized v1.","Tax itemized v1.","Tax summarized v1.","Merchant billing itemized v1.","Tax transactions itemized v1."],"x-flint-enum":"closed"},"source_type":{"const":"installed_merchants"},"status":{"enum":["pending","succeeded","failed"],"readOnly":true,"type":"string","x-enum-descriptions":["Pending.","Succeeded.","Failed."],"x-flint-enum":"open"},"timezone":{"readOnly":true,"type":"string"}},"required":["created_at","currency","interval_end_at","interval_start_at","report_id","report_type","status","timezone","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"report.failed"}}},"Webhook_report_failed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/Report"},"event_type":{"const":"report.failed"}}},"Webhook_report_succeeded_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"oneOf":[{"not":{"anyOf":[{"required":["download"]},{"required":["failure_reason"]}]},"properties":{"status":{"enum":["pending"],"type":"string","x-enum-descriptions":["Pending."],"x-flint-enum":"open"}}},{"not":{"required":["failure_reason"]},"properties":{"status":{"enum":["succeeded"],"type":"string","x-enum-descriptions":["Succeeded."],"x-flint-enum":"open"}},"required":["download"]},{"not":{"required":["download"]},"properties":{"status":{"enum":["failed"],"type":"string","x-enum-descriptions":["Failed."],"x-flint-enum":"open"}},"required":["failure_reason"]}],"properties":{"created_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"currency":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","readOnly":true,"type":"string"},"download":{"$ref":"#/components/schemas/PublicDownload","readOnly":true},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"failure_reason":{"enum":["generation_failed","data_unavailable","limit_exceeded"],"readOnly":true,"type":"string","x-enum-descriptions":["Generation failed.","Data unavailable.","Limit exceeded."],"x-flint-enum":"closed"},"interval_end_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"interval_start_at":{"description":"RFC3339 timestamp.","format":"date-time","readOnly":true,"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"report_id":{"pattern":"^rep_[0-9A-HJKMNP-TV-Z]{26}$","readOnly":true,"type":"string"},"report_type":{"description":"The generated report contract. tax_transactions_itemized_v1 contains frozen Quaderno-backed collection and successful refund evidence for reconciliation and import, not filing instructions.","enum":["orders_itemized_v1","payments_itemized_v1","balance_transactions_itemized_v1","payouts_itemized_v1","tax_itemized_v1","tax_summarized_v1","merchant_billing_itemized_v1","tax_transactions_itemized_v1"],"readOnly":true,"type":"string","x-enum-descriptions":["Orders itemized v1.","Payments itemized v1.","Balance transactions itemized v1.","Payouts itemized v1.","Tax itemized v1.","Tax summarized v1.","Merchant billing itemized v1.","Tax transactions itemized v1."],"x-flint-enum":"closed"},"source_type":{"const":"installed_merchants"},"status":{"enum":["pending","succeeded","failed"],"readOnly":true,"type":"string","x-enum-descriptions":["Pending.","Succeeded.","Failed."],"x-flint-enum":"open"},"timezone":{"readOnly":true,"type":"string"}},"required":["created_at","currency","interval_end_at","interval_start_at","report_id","report_type","status","timezone","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"report.succeeded"}}},"Webhook_report_succeeded_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/Report"},"event_type":{"const":"report.succeeded"}}},"Webhook_return_canceled_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"return.canceled"}}},"Webhook_return_canceled_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"return.canceled"}}},"Webhook_return_completed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"return.completed"}}},"Webhook_return_completed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"return.completed"}}},"Webhook_return_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"return.created"}}},"Webhook_return_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"return.created"}}},"Webhook_return_decision_recorded_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"return.decision_recorded"}}},"Webhook_return_decision_recorded_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"return.decision_recorded"}}},"Webhook_return_disposition_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"return_disposition.created"}}},"Webhook_return_disposition_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"return_disposition.created"}}},"Webhook_return_disposition_updated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"return_disposition.updated"}}},"Webhook_return_disposition_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"return_disposition.updated"}}},"Webhook_return_inspection_acceptance_decided_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"return_inspection.acceptance_decided"}}},"Webhook_return_inspection_acceptance_decided_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"return_inspection.acceptance_decided"}}},"Webhook_return_inspection_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"return_inspection.created"}}},"Webhook_return_inspection_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"return_inspection.created"}}},"Webhook_return_inspection_superseded_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"return_inspection.superseded"}}},"Webhook_return_inspection_superseded_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"return_inspection.superseded"}}},"Webhook_return_receipt_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"return_receipt.created"}}},"Webhook_return_receipt_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"return_receipt.created"}}},"Webhook_return_receipt_superseded_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"return_receipt.superseded"}}},"Webhook_return_receipt_superseded_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"return_receipt.superseded"}}},"Webhook_return_receipt_verified_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"return_receipt.verified"}}},"Webhook_return_receipt_verified_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"return_receipt.verified"}}},"Webhook_return_reopened_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"return.reopened"}}},"Webhook_return_reopened_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"return.reopened"}}},"Webhook_return_resolution_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"return_resolution.created"}}},"Webhook_return_resolution_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"return_resolution.created"}}},"Webhook_return_resolution_updated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"return_resolution.updated"}}},"Webhook_return_resolution_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"return_resolution.updated"}}},"Webhook_return_updated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"}},"required":["source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"return.updated"}}},"Webhook_return_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"type":"object"},"event_type":{"const":"return.updated"}}},"Webhook_review_closed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"properties":{"closed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]},"closed_by":{"type":["string","null"]},"closed_reason":{"enum":["approved","declined","refunded","refunded_as_fraud","disputed","payment_canceled","expired","other",null],"type":["string","null"],"x-enum-descriptions":["Approved.","Declined.","Refunded.","Refunded as fraud.","Disputed.","Payment canceled.","Expired.","Other.","Null."],"x-flint-enum":"closed"},"customer":{"anyOf":[{"$ref":"#/components/schemas/ExpandedCustomerSummary"},{"type":"null"}]},"customer_id":{"type":["string","null"]},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"ip_address":{"type":["string","null"]},"ip_address_location":{"anyOf":[{"$ref":"#/components/schemas/PublicIPAddressLocation"},{"type":"null"}]},"matched_risk_rule_id":{"type":["string","null"]},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"opened_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"opened_reason":{"enum":["rule","manual"],"type":"string","x-enum-descriptions":["Rule.","Manual."],"x-flint-enum":"closed"},"order":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrderSummary"},{"type":"null"}]},"order_id":{"type":["string","null"]},"partner_app_install_id":{"type":"string"},"payment_flow":{"enum":["checkout","payment_link","invoice","subscription_initial","subscription_renewal","virtual_terminal","api"],"type":"string","x-enum-descriptions":["Checkout.","Payment link.","Invoice.","Subscription initial.","Subscription renewal.","Virtual terminal.","Api."],"x-flint-enum":"closed"},"payment_intent":{"anyOf":[{"$ref":"#/components/schemas/ExpandedPaymentIntentSummary"},{"type":"null"}]},"payment_intent_id":{"type":"string"},"payment_summary":{"$ref":"#/components/schemas/PublicRiskPaymentSummary"},"pending_action":{"enum":["approve","decline",null],"type":["string","null"],"x-enum-descriptions":["Approve.","Decline.","Null."],"x-flint-enum":"closed"},"refund_id":{"type":["string","null"]},"refunded_amount_money":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"resolution_started_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]},"resolution_started_by":{"type":["string","null"]},"review_id":{"type":"string"},"risk":{"$ref":"#/components/schemas/PublicReviewRisk"},"source_type":{"const":"installed_merchants"},"status":{"enum":["open","resolving","closed"],"type":"string","x-enum-descriptions":["Open.","Resolving.","Closed."],"x-flint-enum":"open"}},"required":["review_id","status","pending_action","resolution_started_at","resolution_started_by","opened_reason","closed_reason","payment_intent_id","order_id","customer_id","payment_flow","risk","ip_address","ip_address_location","matched_risk_rule_id","payment_summary","refund_id","refunded_amount_money","opened_at","closed_at","closed_by","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"review.closed"}}},"Webhook_review_closed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/Review"},"event_type":{"const":"review.closed"}}},"Webhook_review_opened_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"properties":{"closed_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]},"closed_by":{"type":["string","null"]},"closed_reason":{"enum":["approved","declined","refunded","refunded_as_fraud","disputed","payment_canceled","expired","other",null],"type":["string","null"],"x-enum-descriptions":["Approved.","Declined.","Refunded.","Refunded as fraud.","Disputed.","Payment canceled.","Expired.","Other.","Null."],"x-flint-enum":"closed"},"customer":{"anyOf":[{"$ref":"#/components/schemas/ExpandedCustomerSummary"},{"type":"null"}]},"customer_id":{"type":["string","null"]},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"ip_address":{"type":["string","null"]},"ip_address_location":{"anyOf":[{"$ref":"#/components/schemas/PublicIPAddressLocation"},{"type":"null"}]},"matched_risk_rule_id":{"type":["string","null"]},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"opened_at":{"description":"RFC3339 timestamp.","format":"date-time","type":"string"},"opened_reason":{"enum":["rule","manual"],"type":"string","x-enum-descriptions":["Rule.","Manual."],"x-flint-enum":"closed"},"order":{"anyOf":[{"$ref":"#/components/schemas/ExpandedOrderSummary"},{"type":"null"}]},"order_id":{"type":["string","null"]},"partner_app_install_id":{"type":"string"},"payment_flow":{"enum":["checkout","payment_link","invoice","subscription_initial","subscription_renewal","virtual_terminal","api"],"type":"string","x-enum-descriptions":["Checkout.","Payment link.","Invoice.","Subscription initial.","Subscription renewal.","Virtual terminal.","Api."],"x-flint-enum":"closed"},"payment_intent":{"anyOf":[{"$ref":"#/components/schemas/ExpandedPaymentIntentSummary"},{"type":"null"}]},"payment_intent_id":{"type":"string"},"payment_summary":{"$ref":"#/components/schemas/PublicRiskPaymentSummary"},"pending_action":{"enum":["approve","decline",null],"type":["string","null"],"x-enum-descriptions":["Approve.","Decline.","Null."],"x-flint-enum":"closed"},"refund_id":{"type":["string","null"]},"refunded_amount_money":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}]},"resolution_started_at":{"description":"RFC3339 timestamp.","format":"date-time","type":["string","null"]},"resolution_started_by":{"type":["string","null"]},"review_id":{"type":"string"},"risk":{"$ref":"#/components/schemas/PublicReviewRisk"},"source_type":{"const":"installed_merchants"},"status":{"enum":["open","resolving","closed"],"type":"string","x-enum-descriptions":["Open.","Resolving.","Closed."],"x-flint-enum":"open"}},"required":["review_id","status","pending_action","resolution_started_at","resolution_started_by","opened_reason","closed_reason","payment_intent_id","order_id","customer_id","payment_flow","risk","ip_address","ip_address_location","matched_risk_rule_id","payment_summary","refund_id","refunded_amount_money","opened_at","closed_at","closed_by","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"review.opened"}}},"Webhook_review_opened_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"$ref":"#/components/schemas/Review"},"event_type":{"const":"review.opened"}}},"Webhook_subscription_activated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"},"subscription_id":{"type":"string"}},"required":["subscription_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"subscription.activated"}}},"Webhook_subscription_activated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"subscription_id":{"type":"string"}},"required":["subscription_id"],"type":"object"},"event_type":{"const":"subscription.activated"}}},"Webhook_subscription_canceled_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"},"subscription_id":{"type":"string"}},"required":["subscription_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"subscription.canceled"}}},"Webhook_subscription_canceled_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"subscription_id":{"type":"string"}},"required":["subscription_id"],"type":"object"},"event_type":{"const":"subscription.canceled"}}},"Webhook_subscription_created_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"},"subscription_id":{"type":"string"}},"required":["subscription_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"subscription.created"}}},"Webhook_subscription_created_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"subscription_id":{"type":"string"}},"required":["subscription_id"],"type":"object"},"event_type":{"const":"subscription.created"}}},"Webhook_subscription_dunning_exhausted_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"dunning_end_action":{"enum":["cancel","pause","notify_only"],"type":"string","x-enum-descriptions":["Cancel.","Pause.","Notify only."],"x-flint-enum":"closed"},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"failed_period_ended_at":{"format":"date-time","type":"string"},"failed_period_started_at":{"format":"date-time","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"payment_attempt_id":{"type":"string"},"resource_updated_at":{"format":"date-time","type":"string"},"scheduled_billing_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"status":{"enum":["past_due"],"type":"string","x-enum-descriptions":["Past due."],"x-flint-enum":"open"},"subscription_id":{"type":"string"}},"required":["subscription_id","status","dunning_end_action","failed_period_started_at","failed_period_ended_at","scheduled_billing_at","resource_updated_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"subscription.dunning_exhausted"}}},"Webhook_subscription_dunning_exhausted_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"dunning_end_action":{"enum":["cancel","pause","notify_only"],"type":"string","x-enum-descriptions":["Cancel.","Pause.","Notify only."],"x-flint-enum":"closed"},"failed_period_ended_at":{"format":"date-time","type":"string"},"failed_period_started_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"payment_attempt_id":{"type":"string"},"resource_updated_at":{"format":"date-time","type":"string"},"scheduled_billing_at":{"format":"date-time","type":"string"},"status":{"enum":["past_due"],"type":"string","x-enum-descriptions":["Past due."],"x-flint-enum":"open"},"subscription_id":{"type":"string"}},"required":["subscription_id","status","dunning_end_action","failed_period_started_at","failed_period_ended_at","scheduled_billing_at","resource_updated_at"],"type":"object"},"event_type":{"const":"subscription.dunning_exhausted"}}},"Webhook_subscription_past_due_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"},"subscription_id":{"type":"string"}},"required":["subscription_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"subscription.past_due"}}},"Webhook_subscription_past_due_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"subscription_id":{"type":"string"}},"required":["subscription_id"],"type":"object"},"event_type":{"const":"subscription.past_due"}}},"Webhook_subscription_paused_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"},"subscription_id":{"type":"string"}},"required":["subscription_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"subscription.paused"}}},"Webhook_subscription_paused_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"subscription_id":{"type":"string"}},"required":["subscription_id"],"type":"object"},"event_type":{"const":"subscription.paused"}}},"Webhook_subscription_payment_failed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"partner_app_install_id":{"type":"string"},"scheduled_billing_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"subscription_id":{"type":"string"}},"required":["subscription_id","scheduled_billing_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"subscription.payment_failed"}}},"Webhook_subscription_payment_failed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"order_id":{"type":"string"},"scheduled_billing_at":{"format":"date-time","type":"string"},"subscription_id":{"type":"string"}},"required":["subscription_id","scheduled_billing_at"],"type":"object"},"event_type":{"const":"subscription.payment_failed"}}},"Webhook_subscription_payment_succeeded_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"},"subscription_id":{"type":"string"}},"required":["subscription_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"subscription.payment_succeeded"}}},"Webhook_subscription_payment_succeeded_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"subscription_id":{"type":"string"}},"required":["subscription_id"],"type":"object"},"event_type":{"const":"subscription.payment_succeeded"}}},"Webhook_subscription_renewal_upcoming_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"next_billing_at":{"format":"date-time","type":"string"},"partner_app_install_id":{"type":"string"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"subscription_id":{"type":"string"}},"required":["subscription_id","next_billing_at","resource_updated_at","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"subscription.renewal_upcoming"}}},"Webhook_subscription_renewal_upcoming_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"next_billing_at":{"format":"date-time","type":"string"},"resource_updated_at":{"format":"date-time","type":"string"},"subscription_id":{"type":"string"}},"required":["subscription_id","next_billing_at","resource_updated_at"],"type":"object"},"event_type":{"const":"subscription.renewal_upcoming"}}},"Webhook_subscription_resumed_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"},"subscription_id":{"type":"string"}},"required":["subscription_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"subscription.resumed"}}},"Webhook_subscription_resumed_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"subscription_id":{"type":"string"}},"required":["subscription_id"],"type":"object"},"event_type":{"const":"subscription.resumed"}}},"Webhook_subscription_trial_ending_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"source_type":{"const":"installed_merchants"},"subscription_id":{"type":"string"}},"required":["subscription_id","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"subscription.trial_ending"}}},"Webhook_subscription_trial_ending_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":true,"properties":{"subscription_id":{"type":"string"}},"required":["subscription_id"],"type":"object"},"event_type":{"const":"subscription.trial_ending"}}},"Webhook_subscription_updated_installed_merchants":{"$ref":"#/components/schemas/PartnerWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"changed_fields":{"items":{"type":"string"},"type":"array","uniqueItems":true},"environment_grant_id":{"type":"string"},"environment_id":{"type":"string"},"initiated_by":{"description":"Growable actor vocabulary. Ignore values not recognized by the consumer.","type":"string"},"merchant_id":{"type":"string"},"mode":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"},"partner_app_install_id":{"type":"string"},"previous_values":{"additionalProperties":true,"type":"object"},"resource_updated_at":{"format":"date-time","type":"string"},"source_type":{"const":"installed_merchants"},"subscription_id":{"type":"string"}},"required":["subscription_id","changed_fields","previous_values","resource_updated_at","initiated_by","source_type","mode","merchant_id","partner_app_install_id","environment_grant_id"],"type":"object"},"event_type":{"const":"subscription.updated"}}},"Webhook_subscription_updated_merchant":{"$ref":"#/components/schemas/MerchantWebhookEnvelope","properties":{"data":{"additionalProperties":false,"properties":{"changed_fields":{"items":{"type":"string"},"type":"array","uniqueItems":true},"initiated_by":{"description":"Growable actor vocabulary. Ignore values not recognized by the consumer.","type":"string"},"previous_values":{"additionalProperties":true,"type":"object"},"resource_updated_at":{"format":"date-time","type":"string"},"subscription_id":{"type":"string"}},"required":["subscription_id","changed_fields","previous_values","resource_updated_at","initiated_by"],"type":"object"},"event_type":{"const":"subscription.updated"}}},"Weight":{"properties":{"unit":{"description":"Weight unit. Use gram, kilogram, ounce, or pound.","enum":["gram","kilogram","ounce","pound"],"type":"string","x-enum-descriptions":["Gram.","Kilogram.","Ounce.","Pound."],"x-flint-enum":"closed"},"value":{"format":"int64","type":"integer"}},"required":["unit","value"],"type":"object"}},"securitySchemes":{"ApiKeyHeader":{"description":"Flint secret API key sent directly in the X-API-Key header. Secret keys use the flint_live_ or flint_test_ prefix; keep ordinary secret keys server-side. The first-party docs playground uses a dedicated sandbox-only sample key exception.","in":"header","name":"X-API-Key","type":"apiKey"},"BearerAuth":{"bearerFormat":"Flint API key, partner install token, or short-lived Flint session token","description":"Flint secret API key, CLI OAuth access token, installation-scoped partner token, or session token sent as Authorization: Bearer \u003ctoken\u003e. Route-specific partner access and scopes are declared by x-flint-partner-access and x-flint-partner-required-scopes. Secret API keys use the flint_live_ or flint_test_ prefix; keep ordinary secret keys server-side.","scheme":"bearer","type":"http"},"CheckoutSessionIDHeader":{"description":"Buyer-facing checkout session ID.","in":"header","name":"X-Checkout-Session-ID","type":"apiKey"},"CheckoutSessionSecretHeader":{"description":"Buyer-facing checkout session secret.","in":"header","name":"X-Checkout-Session-Secret","type":"apiKey"},"CustomerSessionBearer":{"bearerFormat":"flint_cses_...","description":"Short-lived, server-side customer session secret. Accepted only by /v1/me endpoints.","scheme":"bearer","type":"http"},"InvoiceAccessTokenBearer":{"bearerFormat":"Invoice access token","description":"Invoice access token from the invoice's public URL. Accepted only for that invoice's buyer detail, PDF, and checkout-session endpoints.","scheme":"bearer","type":"http"},"OnboardingSessionBearer":{"description":"Short-lived onboarding token returned by POST /v1/onboarding/verify-email.","scheme":"bearer","type":"http"}}},"info":{"description":"Flint's public /v1 API for payments, checkout, invoices, subscriptions, catalog, customers, returns, inventory, money movement, webhooks, and developer operations. Use live keys for production and sandbox-bound test keys for staging or sandbox workflows; keep ordinary secret API keys server-side. The first-party docs playground uses a dedicated sandbox-only sample key exception.","title":"Flint Public API","version":"v1"},"jsonSchemaDialect":"https://spec.openapis.org/oas/3.1/dialect/base","openapi":"3.1.2","paths":{"/v1/analytics/overview":{"get":{"description":"Returns high-level merchant analytics for the requested time range.","operationId":"getAnalyticsOverview","parameters":[{"description":"Requested analytics time range.","in":"query","name":"range","required":true,"schema":{"enum":["today","last_7_days","last_30_days","last_90_days"],"type":"string","x-enum-descriptions":["Today.","Last 7 days.","Last 30 days.","Last 90 days."],"x-flint-enum":"closed"}},{"description":"Optional IANA timezone, for example America/New_York.","in":"query","name":"timezone","required":false,"schema":{"type":"string"}},{"description":"Include previous-period comparison metrics.","in":"query","name":"include_previous_period","required":false,"schema":{"type":"boolean"}},{"description":"Restricts amounts and counts to this currency. The currencies list still covers the whole window.","in":"query","name":"currency","required":false,"schema":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"active_subscriptions":{"change_percent":8,"current_count":27,"previous_count":25},"average_payment":{"change_percent":-4.65,"current_money":{"amount":2604,"currency":"USD"},"previous_money":{"amount":2731,"currency":"USD"}},"currencies":["USD"],"gross_volume":{"change_percent":11.61,"current_money":{"amount":125000,"currency":"USD"},"previous_money":{"amount":112000,"currency":"USD"}},"has_multiple_currencies":false,"net_volume":{"change_percent":10.65,"current_money":{"amount":119500,"currency":"USD"},"previous_money":{"amount":108000,"currency":"USD"}},"new_customers":{"change_percent":50,"current_count":9,"previous_count":6},"payments_count":{"change_percent":17.07,"current_count":48,"previous_count":41},"range":"last_7_days","refunds_total":{"change_percent":37.5,"current_money":{"amount":5500,"currency":"USD"},"previous_money":{"amount":4000,"currency":"USD"}},"timezone":"America/New_York"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/AnalyticsOverviewResponse"}}},"description":"The analytics overview.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get analytics overview","tags":["analytics"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_BOOLEAN","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["analytics.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["analytics.read"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"read"}},"/v1/analytics/payment-volume-timeseries":{"get":{"description":"Returns merchant payment volume buckets for the requested time range.","operationId":"getPaymentVolumeTimeseries","parameters":[{"description":"Requested analytics time range.","in":"query","name":"range","required":true,"schema":{"enum":["today","last_7_days","last_30_days","last_90_days"],"type":"string","x-enum-descriptions":["Today.","Last 7 days.","Last 30 days.","Last 90 days."],"x-flint-enum":"closed"}},{"description":"Optional IANA timezone, for example America/New_York.","in":"query","name":"timezone","required":false,"schema":{"type":"string"}},{"description":"Include previous-period comparison buckets.","in":"query","name":"include_previous_period","required":false,"schema":{"type":"boolean"}},{"description":"Restricts bucket volumes and counts to this currency. The currencies list still covers the whole window.","in":"query","name":"currency","required":false,"schema":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"buckets":[{"label":"Mar 10","payments_count":{"change_percent":16.67,"current_count":7,"previous_count":6},"period_end":"2026-03-11T05:00:00Z","period_start":"2026-03-10T05:00:00Z","previous_volume_money":{"amount":15000,"currency":"USD"},"volume_money":{"amount":18000,"currency":"USD"}},{"label":"Mar 11","payments_count":{"change_percent":28.57,"current_count":9,"previous_count":7},"period_end":"2026-03-12T05:00:00Z","period_start":"2026-03-11T05:00:00Z","previous_volume_money":{"amount":17000,"currency":"USD"},"volume_money":{"amount":22000,"currency":"USD"}}],"currencies":["USD"],"has_multiple_currencies":false,"range":"last_7_days","timezone":"America/New_York"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PaymentVolumeTimeseriesResponse"}}},"description":"The payment volume timeseries.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get payment volume timeseries","tags":["analytics"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_BOOLEAN","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["analytics.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["analytics.read"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"read"}},"/v1/analytics/subscriptions":{"get":{"description":"Returns windowed subscription metrics plus current subscription snapshot metrics.","operationId":"getSubscriptionAnalytics","parameters":[{"description":"Requested analytics time range.","in":"query","name":"range","required":true,"schema":{"enum":["today","last_7_days","last_30_days","last_90_days"],"type":"string","x-enum-descriptions":["Today.","Last 7 days.","Last 30 days.","Last 90 days."],"x-flint-enum":"closed"}},{"description":"Optional IANA timezone, for example America/New_York.","in":"query","name":"timezone","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"range":"last_30_days","snapshot_metrics":{"arr_by_currency":[{"amount":1558800,"currency":"USD"}],"mrr_by_currency":[{"amount":129900,"currency":"USD"}],"status_counts":{"active_count":42,"canceled_count":18,"incomplete_count":4,"past_due_count":3,"paused_count":2,"trialing_count":5}},"timezone":"America/New_York","window_metrics":{"canceled_subscriptions":3,"new_subscriptions":14,"subscription_collected_money_by_currency":[{"amount":485000,"currency":"USD"}]}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SubscriptionAnalyticsResponse"}}},"description":"The subscription analytics payload.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get subscription analytics","tags":["analytics"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["analytics.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["analytics.read"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"read"}},"/v1/api-keys":{"get":{"description":"Returns merchant-bound external API key metadata. Internal keys, demo-session keys, and secrets are never returned.","operationId":"listAPIKeys","parameters":[{"description":"Optional API key status filter.","in":"query","name":"status","required":false,"schema":{"enum":["active","revoked"],"type":"string","x-enum-descriptions":["Active.","Revoked."],"x-flint-enum":"open"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["created_at","last_used_at","name"],"type":"string","x-enum-descriptions":["Created at.","Last used at.","Name."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"Only include API keys created at or after this RFC3339 timestamp.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Only include API keys created at or before this RFC3339 timestamp.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Only include API keys updated at or after this RFC3339 timestamp.","in":"query","name":"updated_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Only include API keys updated at or before this RFC3339 timestamp.","in":"query","name":"updated_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"api_key_id":"key_123","created_at":"2026-03-17T14:30:00Z","expires_at":"2027-03-17T14:30:00Z","key_prefix":"flint_test_abcd1234","key_type":"external","last_used_at":"2026-03-17T15:00:00Z","merchant_id":"mer_123","name":"Sandbox orders integration","sandbox_id":"test_01JQEXAMPLEDEFAULT12345678","scopes":["accounts.api_keys.read","accounts.api_keys.write","commerce.orders.read","commerce.orders.write"],"status":"active","updated_at":"2026-03-17T14:30:00Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/APIKeyListResponse"}}},"description":"A page of API key metadata.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List API keys","tags":["api_keys"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["accounts.api_keys.read","accounts.api_keys.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates a merchant-bound external API key. secret_key is returned only in the initial successful response and accepted idempotent replays of the same create request.","operationId":"createAPIKey","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"expires_at":"2027-03-17T14:30:00Z","name":"Sandbox orders integration","sandbox_id":"test_01JQEXAMPLEDEFAULT12345678","scopes":["accounts.api_keys.read","commerce.orders.read","commerce.orders.write"]},"schema":{"$ref":"#/components/schemas/CreateAPIKeyRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"api_key_id":"key_123","created_at":"2026-03-17T14:30:00Z","expires_at":"2027-03-17T14:30:00Z","key_prefix":"flint_test_abcd1234","key_type":"external","last_used_at":"2026-03-17T15:00:00Z","merchant_id":"mer_123","name":"Sandbox orders integration","sandbox_id":"test_01JQEXAMPLEDEFAULT12345678","scopes":["accounts.api_keys.read","accounts.api_keys.write","commerce.orders.read","commerce.orders.write"],"secret_key":"flint_test_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef","status":"active","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CreateAPIKeyResponse"}}},"description":"The created external API key and one-time secret.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Idempotency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create an API key","tags":["api_keys"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["accounts.api_keys.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/api-keys/{api_key_id}":{"get":{"description":"Returns external API key metadata. Secrets, internal keys, and demo-session keys are not returned.","operationId":"getAPIKey","parameters":[{"description":"Flint API key ID.","in":"path","name":"api_key_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"api_key_id":"key_123","created_at":"2026-03-17T14:30:00Z","expires_at":"2027-03-17T14:30:00Z","key_prefix":"flint_test_abcd1234","key_type":"external","last_used_at":"2026-03-17T15:00:00Z","merchant_id":"mer_123","name":"Sandbox orders integration","sandbox_id":"test_01JQEXAMPLEDEFAULT12345678","scopes":["accounts.api_keys.read","accounts.api_keys.write","commerce.orders.read","commerce.orders.write"],"status":"active","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/APIKeyResponse"}}},"description":"The requested API key metadata.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"API key not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get an API key","tags":["api_keys"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["accounts.api_keys.read","accounts.api_keys.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Updates an active external API key's name or complete scope list. API-key-authenticated callers may delegate only scopes already granted to the calling key.","operationId":"updateAPIKey","parameters":[{"description":"Flint API key ID.","in":"path","name":"api_key_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"expires_at":"2027-06-17T14:30:00Z","name":"Sandbox orders readonly","scopes":["accounts.api_keys.read","commerce.orders.read"]},"schema":{"$ref":"#/components/schemas/UpdateAPIKeyRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"api_key_id":"key_123","created_at":"2026-03-17T14:30:00Z","expires_at":"2027-03-17T14:30:00Z","key_prefix":"flint_test_abcd1234","key_type":"external","last_used_at":"2026-03-17T15:00:00Z","merchant_id":"mer_123","name":"Sandbox orders integration","sandbox_id":"test_01JQEXAMPLEDEFAULT12345678","scopes":["accounts.api_keys.read","accounts.api_keys.write","commerce.orders.read","commerce.orders.write"],"status":"active","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/APIKeyResponse"}}},"description":"The updated API key metadata.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"API key not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Idempotency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update an API key","tags":["api_keys"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["accounts.api_keys.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/api-keys/{api_key_id}/revoke":{"post":{"description":"Permanently revokes an external API key and returns metadata with status revoked.","operationId":"revokeAPIKey","parameters":[{"description":"Flint API key ID.","in":"path","name":"api_key_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"api_key_id":"key_123","created_at":"2026-03-17T14:30:00Z","expires_at":"2027-03-17T14:30:00Z","key_prefix":"flint_test_abcd1234","key_type":"external","last_used_at":"2026-03-17T15:00:00Z","merchant_id":"mer_123","name":"Sandbox orders integration","sandbox_id":"test_01JQEXAMPLEDEFAULT12345678","scopes":["accounts.api_keys.read","accounts.api_keys.write","commerce.orders.read","commerce.orders.write"],"status":"revoked","updated_at":"2026-03-17T15:10:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/APIKeyResponse"}}},"description":"The revoked API key metadata.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"API key not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Idempotency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Revoke an API key","tags":["api_keys"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["accounts.api_keys.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/balance-transactions":{"get":{"description":"Returns a paginated ledger of balance-affecting transactions, including availability timing and related public resources.","operationId":"listBalanceTransactions","parameters":[{"description":"Optional 3-letter currency filter.","in":"query","name":"currency","required":false,"schema":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"}},{"description":"Optional balance transaction type filter.","in":"query","name":"type","required":false,"schema":{"enum":["payment","refund","dispute","dispute_reversal","return","recovery","payout","payout_failure","payout_cancellation","payout_reversal","payout_advance","payout_advance_funding","reserve_hold","reserve_release","payout_hold","payout_hold_release","adjustment","merchant_billing_payment","merchant_billing_payment_reversal"],"type":"string","x-enum-descriptions":["Payment.","Refund.","Dispute.","Dispute reversal.","Return.","Recovery.","Payout.","Payout failure.","Payout cancellation.","Payout reversal.","Payout advance.","Payout advance funding.","Reserve hold.","Reserve release.","Payout hold.","Payout hold release.","Adjustment.","Merchant billing payment.","Merchant billing payment reversal."],"x-flint-enum":"closed"}},{"description":"Optional related object type filter.","in":"query","name":"related_object_type","required":false,"schema":{"enum":["payment_intent","refund","dispute","payout","payout_destination","reserve","adjustment","merchant_subscription_invoice"],"type":"string","x-enum-descriptions":["Payment intent.","Refund.","Dispute.","Payout.","Payout destination.","Reserve.","Adjustment.","Merchant subscription invoice."],"x-flint-enum":"closed"}},{"description":"Optional related object ID filter.","in":"query","name":"related_object_id","required":false,"schema":{"type":"string"}},{"description":"Optional balance transaction status filter. Default list responses exclude terminal audit rows; filter by reversed or superseded to retrieve those rows explicitly.","in":"query","name":"status","required":false,"schema":{"enum":["pending","available","reserved","reversed","failed","superseded"],"type":"string","x-enum-descriptions":["Pending.","Available.","Reserved.","Reversed.","Failed.","Superseded."],"x-flint-enum":"open"}},{"description":"Only include balance transactions created at or after this RFC3339 timestamp.","in":"query","name":"created_after","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Only include balance transactions created at or before this RFC3339 timestamp.","in":"query","name":"created_before","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Only include balance transactions available at or after this RFC3339 timestamp.","in":"query","name":"available_after","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Only include balance transactions available at or before this RFC3339 timestamp.","in":"query","name":"available_before","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BalanceTransactionListResponse"}}},"description":"Balance transactions for the authenticated merchant.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List balance transactions","tags":["money_movement"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["money_movement.balance_transactions.read"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"read"}},"/v1/balance-transactions/{balance_transaction_id}":{"get":{"description":"Returns one balance transaction by ID, with optional related order expansion.","operationId":"getBalanceTransaction","parameters":[{"description":"Flint balance transaction ID.","in":"path","name":"balance_transaction_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: order. Expansion requires money_movement.balance_transactions.read plus commerce.orders.read. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=order\u0026expand=order, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["order"],"type":"string","x-enum-descriptions":["Order."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Balance transaction","value":{"data":{"amount_money":{"amount":5000,"currency":"USD"},"available_at":"2026-03-19T00:00:00Z","balance_transaction_id":"btxn_123","currency":"USD","description":"Payment for order 1001","fee_money":{"amount":175,"currency":"USD"},"merchant_id":"mer_123","net_money":{"amount":4825,"currency":"USD"},"occurred_at":"2026-03-17T14:30:00Z","order_id":"ord_123","status":"available","type":"payment"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Balance transaction with expanded order","value":{"data":{"amount_money":{"amount":5000,"currency":"USD"},"available_at":"2026-03-19T00:00:00Z","balance_transaction_id":"btxn_123","currency":"USD","description":"Payment for order 1001","fee_money":{"amount":175,"currency":"USD"},"merchant_id":"mer_123","net_money":{"amount":4825,"currency":"USD"},"occurred_at":"2026-03-17T14:30:00Z","order":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","fulfillment_status":"not_fulfilled","order_id":"ord_123","order_number":"1001","payment_intent_ids":["pi_123"],"payment_status":"","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":0,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":5000,"currency":"USD"},"outstanding_money":{"amount":0,"currency":"USD"},"paid_money":{"amount":5000,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"paid","updated_at":"2026-03-17T14:30:00Z"},"order_id":"ord_123","status":"available","type":"payment"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/BalanceTransactionResponse"}}},"description":"The requested balance transaction.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Balance transaction not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get a balance transaction","tags":["money_movement"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["money_movement.balance_transactions.read"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"read"}},"/v1/balances":{"get":{"description":"Returns an unpaginated current balance snapshot grouped by currency and balance source for the authenticated merchant.","operationId":"listBalances","parameters":[{"description":"Optional 3-letter currency filter.","in":"query","name":"currency","required":false,"schema":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BalanceListResponse"}}},"description":"Balances for the authenticated merchant.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List balances","tags":["money_movement"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["money_movement.balances.read"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"read"}},"/v1/bundles":{"get":{"description":"List bundles.","operationId":"listBundles","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Filter by exact SKU.","in":"query","name":"sku","required":false,"schema":{"type":"string"}},{"description":"Search across bundle ID, external reference ID, name, description, and SKU.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Filter by category handle.","in":"query","name":"category_handle","required":false,"schema":{"type":"string"}},{"description":"Filter by bundle status.","in":"query","name":"status","required":false,"schema":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["created_at","updated_at","name"],"type":"string","x-enum-descriptions":["Created at.","Updated at.","Name."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"Filter bundles with at least one component assigned to this delivery profile.","in":"query","name":"delivery_profile_id","required":false,"schema":{"type":"string"}},{"description":"Filter by aggregated delivery readiness across bundle components.","in":"query","name":"delivery_configuration_status","required":false,"schema":{"enum":["configured","action_required","not_applicable"],"type":"string","x-enum-descriptions":["Configured.","Action required.","Not applicable."],"x-flint-enum":"open"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/BundleListResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List bundles","tags":["bundles"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.bundles.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.bundles.read","commerce.bundles.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Create bundle.","operationId":"createBundle","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"name":"Weekend pass","unit_price_money":{"amount":4500,"currency":"USD"}},"schema":{"$ref":"#/components/schemas/CreateBundleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"available_for_sale":true,"bundle_id":"bun_123","component_count":0,"created_at":"2026-03-17T14:30:00Z","delivery_configuration_status":"not_applicable","images":[],"merchant_id":"mer_123","modifier_set_id":null,"name":"Weekend pass","status":"active","unit_price_money":{"amount":4500,"currency":"USD"},"updated_at":"2026-03-17T14:30:00Z","version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/BundleResponse"}}},"description":"The created bundle.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The image source is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create bundle","tags":["bundles"],"x-flint-error-codes":["AUTH_REQUIRED","BUNDLE_COMPONENTS_REQUIRED","BUNDLE_COMPONENT_PRODUCT_NOT_ACTIVE","BUNDLE_COMPONENT_VARIANT_NOT_ACTIVE","COMPONENT_REQUIRED","DELIVERY_PROFILE_NOT_APPLICABLE","DUPLICATE_COMPONENT_VARIANT","DUPLICATE_IMAGE_EXTERNAL_REFERENCE_ID","DUPLICATE_IMAGE_SOURCE","FULFILLMENT_PROFILE_REQUIRED","FULFILLMENT_PROFILE_UNAVAILABLE","IMAGE_ANIMATION_UNSUPPORTED","IMAGE_ASSET_NOT_ATTACHABLE","IMAGE_ASSET_NOT_FOUND","IMAGE_DIMENSIONS_EXCEEDED","IMAGE_FORMAT_UNSUPPORTED","IMAGE_GALLERY_LIMIT_EXCEEDED","IMAGE_INGESTION_COUNT_EXCEEDED","IMAGE_INGESTION_EXPIRED","IMAGE_INGESTION_IN_PROGRESS","IMAGE_INGESTION_RESTART_REQUIRED","IMAGE_NOT_ATTACHABLE","IMAGE_OWNER_NOT_MUTABLE","IMAGE_PIXEL_BUDGET_EXCEEDED","IMAGE_PROCESSING_CAPACITY_EXCEEDED","IMAGE_PROCESSING_FAILED","IMAGE_PROCESSING_TIMEOUT","IMAGE_SOURCE_FETCH_FAILED","IMAGE_SOURCE_NOT_PUBLIC","IMAGE_SOURCE_TIMEOUT","IMAGE_SOURCE_TOO_LARGE","IMAGE_SOURCE_UNAVAILABLE","IMAGE_SOURCE_URL_INVALID","IMAGE_STORAGE_QUOTA_EXCEEDED","IMAGE_URL_INVALID","IMAGE_URL_MUST_BE_CANONICAL","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_COMPONENT_POSITION","INVALID_COMPONENT_QUANTITY","INVALID_IMAGE_ALT","INVALID_IMAGE_EXTERNAL_REFERENCE_ID","INVALID_IMAGE_GALLERY","INVALID_REQUEST","NORMALIZED_IMAGE_TOO_LARGE","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVER_GENERATED_ID","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.bundles.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.bundles.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/bundles/{bundle_id}":{"delete":{"description":"Archives a bundle and returns its final state.","operationId":"deleteBundle","parameters":[{"description":"Flint bundle ID.","in":"path","name":"bundle_id","required":true,"schema":{"type":"string"}},{"description":"Optional bundle version last read by the caller.","in":"query","name":"expected_version","required":false,"schema":{"format":"uint64","minimum":1,"type":"integer"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"available_for_sale":false,"bundle_id":"bun_123","component_count":0,"created_at":"2026-03-17T14:30:00Z","delivery_configuration_status":"not_applicable","images":[],"merchant_id":"mer_123","modifier_set_id":null,"name":"Weekend pass","status":"archived","unit_price_money":{"amount":4500,"currency":"USD"},"updated_at":"2026-03-17T14:35:00Z","version":2},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/BundleResponse"}}},"description":"The archived bundle.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Retire bundle","tags":["bundles"],"x-flint-error-codes":["AUTH_REQUIRED","CONCURRENT_MODIFICATION","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_EXPECTED_VERSION","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.bundles.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.bundles.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Get bundle.","operationId":"getBundle","parameters":[{"description":"Flint bundle ID.","in":"path","name":"bundle_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: modifier_set. Expand the attached modifier set. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=modifier_set\u0026expand=modifier_set, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["modifier_set"],"type":"string","x-enum-descriptions":["Modifier set."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Resource","value":{"data":{"available_for_sale":true,"bundle_id":"bun_123","component_count":0,"created_at":"2026-03-17T14:30:00Z","delivery_configuration_status":"not_applicable","images":[],"merchant_id":"mer_123","modifier_set_id":null,"name":"Weekend pass","status":"active","unit_price_money":{"amount":4500,"currency":"USD"},"updated_at":"2026-03-17T14:30:00Z","version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Resource with modifier set","value":{"data":{"available_for_sale":true,"bundle_id":"bun_123","component_count":0,"created_at":"2026-03-17T14:30:00Z","delivery_configuration_status":"not_applicable","images":[],"merchant_id":"mer_123","modifier_set":{"modifier_groups":[],"modifier_set_id":"ms_01J00000000000000000000000","name":"Engraving","status":"active","version":1},"modifier_set_id":"ms_01J00000000000000000000000","name":"Weekend pass","status":"active","unit_price_money":{"amount":4500,"currency":"USD"},"updated_at":"2026-03-17T14:30:00Z","version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/BundleResponse"}}},"description":"The bundle.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get bundle","tags":["bundles"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.bundles.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.bundles.read","commerce.bundles.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Update bundle.","operationId":"updateBundle","parameters":[{"description":"Flint bundle ID.","in":"path","name":"bundle_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"expected_version":1,"name":"Weekend admission pass"},"schema":{"$ref":"#/components/schemas/UpdateBundleRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"available_for_sale":true,"bundle_id":"bun_123","component_count":0,"created_at":"2026-03-17T14:30:00Z","delivery_configuration_status":"not_applicable","images":[],"merchant_id":"mer_123","modifier_set_id":null,"name":"Weekend admission pass","status":"active","unit_price_money":{"amount":4500,"currency":"USD"},"updated_at":"2026-03-17T14:35:00Z","version":2},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/BundleResponse"}}},"description":"The updated bundle.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The image source is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update bundle","tags":["bundles"],"x-flint-error-codes":["ACTIVE_BUNDLE_COMPONENTS_IMMUTABLE","AUTH_REQUIRED","BUNDLE_COMPONENTS_REQUIRED","BUNDLE_COMPONENT_PRODUCT_NOT_ACTIVE","BUNDLE_COMPONENT_VARIANT_NOT_ACTIVE","COMPONENT_REQUIRED","CONCURRENT_MODIFICATION","DELIVERY_PROFILE_NOT_APPLICABLE","DUPLICATE_BUNDLE_COMPONENT_ID","DUPLICATE_COMPONENT_VARIANT","DUPLICATE_IMAGE_EXTERNAL_REFERENCE_ID","DUPLICATE_IMAGE_SOURCE","EXPECTED_VERSION_REQUIRED","FULFILLMENT_PROFILE_REQUIRED","FULFILLMENT_PROFILE_UNAVAILABLE","IMAGE_ANIMATION_UNSUPPORTED","IMAGE_ASSET_NOT_ATTACHABLE","IMAGE_ASSET_NOT_FOUND","IMAGE_DIMENSIONS_EXCEEDED","IMAGE_FORMAT_UNSUPPORTED","IMAGE_GALLERY_LIMIT_EXCEEDED","IMAGE_INGESTION_COUNT_EXCEEDED","IMAGE_INGESTION_EXPIRED","IMAGE_INGESTION_IN_PROGRESS","IMAGE_INGESTION_RESTART_REQUIRED","IMAGE_NOT_ATTACHABLE","IMAGE_OWNER_NOT_MUTABLE","IMAGE_PIXEL_BUDGET_EXCEEDED","IMAGE_PROCESSING_CAPACITY_EXCEEDED","IMAGE_PROCESSING_FAILED","IMAGE_PROCESSING_TIMEOUT","IMAGE_SOURCE_FETCH_FAILED","IMAGE_SOURCE_NOT_PUBLIC","IMAGE_SOURCE_TIMEOUT","IMAGE_SOURCE_TOO_LARGE","IMAGE_SOURCE_UNAVAILABLE","IMAGE_SOURCE_URL_INVALID","IMAGE_STORAGE_QUOTA_EXCEEDED","IMAGE_URL_INVALID","IMAGE_URL_MUST_BE_CANONICAL","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_CATEGORIES","INVALID_COMPONENTS","INVALID_COMPONENT_POSITION","INVALID_COMPONENT_QUANTITY","INVALID_EXPECTED_VERSION","INVALID_IMAGE_ALT","INVALID_IMAGE_EXTERNAL_REFERENCE_ID","INVALID_IMAGE_GALLERY","INVALID_REQUEST","NORMALIZED_IMAGE_TOO_LARGE","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVER_GENERATED_ID","SERVICE_UNAVAILABLE","UNKNOWN_BUNDLE_COMPONENT"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.bundles.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.bundles.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/bundles/{bundle_id}/components":{"get":{"description":"List bundle components.","operationId":"listBundleComponents","parameters":[{"description":"Flint bundle ID.","in":"path","name":"bundle_id","required":true,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by assigned delivery profile ID.","in":"query","name":"delivery_profile_id","required":false,"schema":{"type":"string"}},{"description":"Filter by delivery readiness.","in":"query","name":"delivery_configuration_status","required":false,"schema":{"enum":["configured","action_required","not_applicable"],"type":"string","x-enum-descriptions":["Configured.","Action required.","Not applicable."],"x-flint-enum":"open"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/BundleComponentListResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List bundle components","tags":["bundles"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.bundles.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.bundles.read","commerce.bundles.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/capabilities":{"get":{"description":"Returns payment and money movement capability readiness for the authenticated merchant.","operationId":"listCapabilities","parameters":[{"description":"Optional capability domain filter. capabilities.read authorizes both payment and money movement readiness.","in":"query","name":"domain","required":false,"schema":{"enum":["money_movement","payments"],"type":"string","x-enum-descriptions":["Money movement.","Payments."],"x-flint-enum":"closed"}},{"description":"Optional Flint capability name filter.","in":"query","name":"capability","required":false,"schema":{"enum":["accept_card_payments","save_payment_methods","accept_affirm_payments","receive_payouts","create_standard_payouts","manage_payout_destinations","manage_payout_settings"],"type":"string","x-enum-descriptions":["Accept card payments.","Save payment methods.","Accept affirm payments.","Receive payouts.","Create standard payouts.","Manage payout destinations.","Manage payout settings."],"x-flint-enum":"closed"}},{"description":"Optional capability status filter.","in":"query","name":"status","required":false,"schema":{"enum":["ready","blocked","pending","not_available"],"type":"string","x-enum-descriptions":["Ready.","Blocked.","Pending.","Not available."],"x-flint-enum":"open"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapabilityListResponse"}}},"description":"Payment and money movement capabilities for the authenticated merchant.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List merchant capabilities","tags":["capabilities"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["capabilities.read"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"read"}},"/v1/categories":{"get":{"description":"List categories.","operationId":"listCategories","parameters":[{"description":"Filter by category status.","in":"query","name":"status","required":false,"schema":{"enum":["active","archived"],"type":"string","x-enum-descriptions":["Active.","Archived."],"x-flint-enum":"open"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search across category ID, external reference ID, handle, name, and description.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"assigned_bundle_count":1,"assigned_product_count":2,"category_id":"ctg_01J00000000000000000000000","created_at":"2026-03-17T14:30:00Z","handle":"events","merchant_id":"mer_123","metadata":{"department":"admissions"},"name":"Events","status":"active","targeting_reference_count":0,"updated_at":"2026-03-17T14:30:00Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CategoryListResponse"}}},"description":"A page of categories.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List categories","tags":["categories"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_CATEGORY_STATUS","INVALID_PAGE_SIZE","INVALID_PAGE_TOKEN","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","UNSUPPORTED_QUERY_PARAM"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.catalog.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.catalog.read","commerce.catalog.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates a reusable category. If handle is omitted, Flint derives it from the name and never changes it on rename.","operationId":"createCategory","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"handle":"events","name":"Events"},"schema":{"$ref":"#/components/schemas/CreateCategoryRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"assigned_bundle_count":1,"assigned_product_count":2,"category_id":"ctg_01J00000000000000000000000","created_at":"2026-03-17T14:30:00Z","handle":"events","merchant_id":"mer_123","metadata":{"department":"admissions"},"name":"Events","status":"active","targeting_reference_count":0,"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CategoryResponse"}}},"description":"The created category.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create category","tags":["categories"],"x-flint-error-codes":["AUTH_REQUIRED","CATEGORY_HANDLE_EXISTS","IDEMPOTENCY_CLEAR_FAILED","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","IDEMPOTENCY_LOAD_FAILED","IDEMPOTENCY_PERSIST_FAILED","IDEMPOTENCY_RECOVERY_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_CATEGORY_DESCRIPTION","INVALID_CATEGORY_HANDLE","INVALID_CATEGORY_NAME","INVALID_IDEMPOTENCY_KEY","INVALID_METADATA","INVALID_REQUEST","NULL_NOT_ALLOWED","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.catalog.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.catalog.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/categories/{category_id}":{"delete":{"description":"Permanently deletes an unreferenced category and returns it with status deleted. Deleted categories cannot be retrieved or listed. Remove all product, bundle, promotion, and return configuration references before deleting.","operationId":"deleteCategory","parameters":[{"description":"Flint category ID.","in":"path","name":"category_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CategoryResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Delete category","tags":["categories"],"x-flint-error-codes":["AUTH_REQUIRED","CATEGORY_REFERENCED","IDEMPOTENCY_CLEAR_FAILED","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","IDEMPOTENCY_LOAD_FAILED","IDEMPOTENCY_PERSIST_FAILED","IDEMPOTENCY_RECOVERY_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_IDEMPOTENCY_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.catalog.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.catalog.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Get category.","operationId":"getCategory","parameters":[{"description":"Flint category ID.","in":"path","name":"category_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"assigned_bundle_count":1,"assigned_product_count":2,"category_id":"ctg_01J00000000000000000000000","created_at":"2026-03-17T14:30:00Z","handle":"events","merchant_id":"mer_123","metadata":{"department":"admissions"},"name":"Events","status":"active","targeting_reference_count":0,"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CategoryResponse"}}},"description":"The requested category.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get category","tags":["categories"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.catalog.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.catalog.read","commerce.catalog.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Update category.","operationId":"updateCategory","parameters":[{"description":"Flint category ID.","in":"path","name":"category_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{},"schema":{"$ref":"#/components/schemas/UpdateCategoryRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CategoryResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update category","tags":["categories"],"x-flint-error-codes":["AUTH_REQUIRED","CATEGORY_MODIFIED","IDEMPOTENCY_CLEAR_FAILED","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","IDEMPOTENCY_LOAD_FAILED","IDEMPOTENCY_PERSIST_FAILED","IDEMPOTENCY_RECOVERY_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_CATEGORY_DESCRIPTION","INVALID_CATEGORY_NAME","INVALID_IDEMPOTENCY_KEY","INVALID_METADATA","INVALID_REQUEST","NO_FIELDS_TO_UPDATE","NULL_NOT_ALLOWED","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.catalog.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.catalog.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/checkout-sessions":{"get":{"description":"Returns a paginated list of checkout sessions for the authenticated merchant.","operationId":"listCheckoutSessions","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by checkout session status.","in":"query","name":"status","required":false,"schema":{"enum":["open","paid","partially_paid","expired","closed","invalidated"],"type":"string","x-enum-descriptions":["Open.","Paid.","Partially paid.","Expired.","Closed.","Invalidated."],"x-flint-enum":"open"}},{"description":"Filter by Flint order ID.","in":"query","name":"order_id","required":false,"schema":{"type":"string"}},{"description":"Filter by Flint payment link ID.","in":"query","name":"payment_link_id","required":false,"schema":{"type":"string"}},{"description":"Filter by Flint customer ID.","in":"query","name":"customer_id","required":false,"schema":{"type":"string"}},{"description":"Filter by checkout session origin.","in":"query","name":"origin","required":false,"schema":{"enum":["virtual_terminal","payment_link","checkout","api","subscription"],"type":"string","x-enum-descriptions":["Virtual terminal.","Payment link.","Checkout.","Api.","Subscription."],"x-flint-enum":"closed"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search across checkout session ID, external reference ID, metadata, and payment notes.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["created_at","updated_at"],"type":"string","x-enum-descriptions":["Created at.","Updated at."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"RFC3339 lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 lower bound for updated_at.","in":"query","name":"updated_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for updated_at.","in":"query","name":"updated_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 lower bound for expires_at.","in":"query","name":"expires_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for expires_at.","in":"query","name":"expires_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"checkout_session_id":"cs_123","created_at":"2026-03-17T14:30:00Z","customer_collection":{"require_email":true},"delivery_method_ids":null,"delivery_selection_required":false,"merchant_id":"mer_123","metadata":{"campaign":"spring_launch"},"order_id":"ord_123","origin":"api","payments":{"enabled_payment_options":["card","apple_pay","google_pay"],"payment_note":"Thank you for your purchase."},"problems":[],"promotion_config":{"codes_enabled":true},"recovery_mode":false,"redirects":{"cancel_redirect_url":"https://example.com/canceled","success_redirect_url":"https://example.com/success"},"status":"open","surface":"hosted","theme":{"primary_color":"#0f766e","title":"Spring Gala Checkout"},"updated_at":"2026-03-17T14:30:00Z","url":"https://checkout.withflintpay.com/checkout/cs_123#checkout_token=tok_123"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CheckoutSessionListResponse"}}},"description":"A page of checkout sessions.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List checkout sessions","tags":["checkout_sessions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["checkouts.checkout_sessions.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["checkouts.checkout_sessions.read","checkouts.checkout_sessions.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates a hosted or embedded checkout session for an order, quick-pay charge, or subscription plan signup. Creation never implicitly replaces an open order session. To replace one, send order_id with replace_checkout_session_id set to the expected current session; the compare-and-swap replacement and collection-lock transfer commit atomically.","operationId":"createCheckoutSession","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"customer_collection":{"require_email":true},"metadata":{"campaign":"spring_launch"},"payments":{"enabled_payment_options":["card","apple_pay","google_pay"],"payment_note":"Thank you for your purchase."},"promotion_config":{"codes_enabled":true},"quick_pay_item":{"amount_money":{"amount":2500,"currency":"USD"},"name":"Service Fee"},"redirects":{"cancel_redirect_url":"https://example.com/canceled","success_redirect_url":"https://example.com/success"},"theme":{"primary_color":"#0f766e","title":"Spring Gala Checkout"}},"schema":{"$ref":"#/components/schemas/CreateCheckoutSessionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"checkout_access":{"checkout_auth_token":"ckat_v1.example_session_credential","hosted_url":"https://checkout.withflintpay.com/checkout/cs_123#checkout_token=tok_123"},"checkout_session":{"checkout_session_id":"cs_123","created_at":"2026-03-17T14:30:00Z","customer_collection":{"require_email":true},"delivery_method_ids":null,"delivery_selection_required":false,"merchant_id":"mer_123","metadata":{"campaign":"spring_launch"},"order_id":"ord_123","origin":"api","payments":{"enabled_payment_options":["card","apple_pay","google_pay"],"payment_note":"Thank you for your purchase."},"problems":[],"promotion_config":{"codes_enabled":true},"recovery_mode":false,"redirects":{"cancel_redirect_url":"https://example.com/canceled","success_redirect_url":"https://example.com/success"},"status":"open","surface":"hosted","theme":{"primary_color":"#0f766e","title":"Spring Gala Checkout"},"updated_at":"2026-03-17T14:30:00Z","url":"https://checkout.withflintpay.com/checkout/cs_123#checkout_token=tok_123"},"hosted_checkout":{"checkout_auth_token":"ckat_v1.example_session_credential","url":"https://checkout.withflintpay.com/checkout/cs_123#checkout_token=tok_123"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CheckoutSessionLaunchResponse"}}},"description":"The created checkout session and surface-appropriate access details.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create checkout session","tags":["checkout_sessions"],"x-flint-error-codes":["AUTH_REQUIRED","EMBEDDED_PAYMENT_RETURN_URL_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["checkouts.checkout_sessions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["checkouts.checkout_sessions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/checkout-sessions/{checkout_session_id}":{"get":{"description":"Returns a single checkout session by ID.","operationId":"getCheckoutSession","parameters":[{"description":"Flint checkout session ID.","in":"path","name":"checkout_session_id","required":true,"schema":{"type":"string"}},{"description":"Checkout session ID for buyer-facing checkout authentication.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret for buyer-facing checkout authentication.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"Supported expansions: customer, invoice, order, payment_intents, payment_link. Expansion requires checkouts.checkout_sessions.read plus the read scope for each expanded resource. Limits: at most 10 unique expand paths per request; path depth at most 2. To-many expansions are capped at 20 related objects per path. Repeat expand, for example expand=customer\u0026expand=invoice, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["customer","invoice","order","payment_intents","payment_link"],"type":"string","x-enum-descriptions":["Customer.","Invoice.","Order.","Payment intents.","Payment link."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Checkout session","value":{"data":{"checkout_session_id":"cs_123","created_at":"2026-03-17T14:30:00Z","customer_collection":{"require_email":true},"delivery_method_ids":null,"delivery_selection_required":false,"merchant_id":"mer_123","metadata":{"campaign":"spring_launch"},"order_id":"ord_123","origin":"api","payments":{"enabled_payment_options":["card","apple_pay","google_pay"],"payment_note":"Thank you for your purchase."},"problems":[],"promotion_config":{"codes_enabled":true},"recovery_mode":false,"redirects":{"cancel_redirect_url":"https://example.com/canceled","success_redirect_url":"https://example.com/success"},"status":"open","surface":"hosted","theme":{"primary_color":"#0f766e","title":"Spring Gala Checkout"},"updated_at":"2026-03-17T14:30:00Z","url":"https://checkout.withflintpay.com/checkout/cs_123#checkout_token=tok_123"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Checkout session with expanded relationships","value":{"data":{"checkout_session_id":"cs_123","created_at":"2026-03-17T14:30:00Z","customer":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","email":"jane@example.com","name":"Jane Doe","phone":"+14155552671","updated_at":"2026-03-17T14:30:00Z"},"customer_collection":{"customer_id":"cus_123","require_email":true},"delivery_method_ids":null,"delivery_selection_required":false,"invoice":{"created_at":"2026-03-21T15:03:00Z","customer_id":"cus_01J00000000000000000000000","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"status":"open","updated_at":"2026-03-21T15:04:05Z"},"invoice_id":"inv_01J00000000000000000000000","merchant_id":"mer_123","metadata":{"campaign":"spring_launch"},"order":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","order_id":"ord_123","order_number":"1001","payment_intent_ids":["pi_123"],"payment_status":"","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","updated_at":"2026-03-17T14:30:00Z"},"order_id":"ord_123","origin":"api","payment_intent_ids":["pi_123"],"payment_intents":[{"amount_money":{"amount":5000,"currency":"USD"},"capture_method":"automatic","created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","order_id":"ord_123","payment_intent_id":"pi_123","refund_status":"none","status":"requires_confirmation","updated_at":"2026-03-17T14:30:00Z"}],"payment_link":{"completed_count":3,"created_at":"2026-03-17T14:30:00Z","description":"Event checkout","name":"Spring Gala","payment_link_id":"pl_123","payment_link_type":"event","status":"active","updated_at":"2026-03-17T14:30:00Z","url":"https://checkout.withflintpay.com/pay/pl_123"},"payment_link_id":"pl_123","payments":{"enabled_payment_options":["card","apple_pay","google_pay"],"payment_note":"Thank you for your purchase."},"problems":[],"promotion_config":{"codes_enabled":true},"recovery_mode":false,"redirects":{"cancel_redirect_url":"https://example.com/canceled","success_redirect_url":"https://example.com/success"},"status":"open","surface":"hosted","theme":{"primary_color":"#0f766e","title":"Spring Gala Checkout"},"updated_at":"2026-03-17T14:30:00Z","url":"https://checkout.withflintpay.com/checkout/cs_123#checkout_token=tok_123"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/CheckoutSessionResponse"}}},"description":"The requested checkout session.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"checkout session not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Checkout session not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get checkout session","tags":["checkout_sessions"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["checkouts.checkout_sessions.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["checkouts.checkout_sessions.read","checkouts.checkout_sessions.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Updates mutable checkout session fields. Currently only metadata is mutable.","operationId":"updateCheckoutSession","parameters":[{"description":"Flint checkout session ID.","in":"path","name":"checkout_session_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"metadata":{"campaign":"spring_launch","channel":"email"}},"schema":{"$ref":"#/components/schemas/UpdateCheckoutSessionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"checkout_session_id":"cs_123","created_at":"2026-03-17T14:30:00Z","customer_collection":{"require_email":true},"delivery_method_ids":null,"delivery_selection_required":false,"merchant_id":"mer_123","metadata":{"campaign":"spring_launch"},"order_id":"ord_123","origin":"api","payments":{"enabled_payment_options":["card","apple_pay","google_pay"],"payment_note":"Thank you for your purchase."},"problems":[],"promotion_config":{"codes_enabled":true},"recovery_mode":false,"redirects":{"cancel_redirect_url":"https://example.com/canceled","success_redirect_url":"https://example.com/success"},"status":"open","surface":"hosted","theme":{"primary_color":"#0f766e","title":"Spring Gala Checkout"},"updated_at":"2026-03-17T14:30:00Z","url":"https://checkout.withflintpay.com/checkout/cs_123#checkout_token=tok_123"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CheckoutSessionResponse"}}},"description":"The updated checkout session.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"checkout session not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Checkout session not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update checkout session","tags":["checkout_sessions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["checkouts.checkout_sessions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["checkouts.checkout_sessions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/checkout-sessions/{checkout_session_id}/close":{"post":{"description":"Closes an open checkout session before it naturally expires.","operationId":"closeCheckoutSession","parameters":[{"description":"Flint checkout session ID.","in":"path","name":"checkout_session_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"reason":"Merchant closed stale session"},"schema":{"$ref":"#/components/schemas/CloseCheckoutSessionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"checkout_session_id":"cs_123","created_at":"2026-03-17T14:30:00Z","customer_collection":{"require_email":true},"delivery_method_ids":null,"delivery_selection_required":false,"merchant_id":"mer_123","metadata":{"campaign":"spring_launch"},"order_id":"ord_123","origin":"api","payments":{"enabled_payment_options":["card","apple_pay","google_pay"],"payment_note":"Thank you for your purchase."},"problems":[],"promotion_config":{"codes_enabled":true},"recovery_mode":false,"redirects":{"cancel_redirect_url":"https://example.com/canceled","success_redirect_url":"https://example.com/success"},"status":"open","surface":"hosted","theme":{"primary_color":"#0f766e","title":"Spring Gala Checkout"},"updated_at":"2026-03-17T14:30:00Z","url":"https://checkout.withflintpay.com/checkout/cs_123#checkout_token=tok_123"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CheckoutSessionResponse"}}},"description":"The closed checkout session.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"checkout session not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Checkout session not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Close checkout session","tags":["checkout_sessions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["checkouts.checkout_sessions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["checkouts.checkout_sessions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/checkout-sessions/{checkout_session_id}/delivery-quotes":{"post":{"description":"Creates an exact checkout-bound delivery quote without holding inventory.","operationId":"createCheckoutSessionDeliveryQuote","parameters":[{"description":"Flint checkout session ID.","in":"path","name":"checkout_session_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Checkout session ID for buyer-facing checkout authentication.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret for buyer-facing checkout authentication.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"expected_delivery_selection_id":"example"},"schema":{"$ref":"#/components/schemas/CreateCheckoutDeliveryQuoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"audience":"merchant","checkout_session_id":"cs_01K1P6G4M7H2N8Q9R3S5T6V7WX","choice_groups":[{"availability_status":"ready","delivery_choice_group_id":"dcgrp_01K1P6G4M7H2N8Q9R3S5T6V7WX","evaluation_status":"complete","input_requirements":[{"constraint":{"type":"string"},"delivery_input_requirement_id":"example","field_path":"destination_address","purpose":"quote"}],"line_items":[{"order_line_item_id":"example","quantity":1}],"options":[{"amount_money":{"amount":0,"currency":"USD"},"buyer_instructions":{"enabled":true,"required":true},"delivery_method_id":"dmet_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_plan":{"type":"single_delivery"},"display_position":1,"name":"Standard delivery","recommended":true,"taxable":true,"type":"shipment","window_selection":"none"}],"stable_key":"example"}],"delivery_quote_id":"dqt_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_quote_revision":0,"eligibility_context_revision":0,"evaluated_at":"2026-08-02T16:00:00Z","evaluation_status":"complete","expires_at":"2026-08-02T16:00:00Z","input_requirements":[{"constraint":{"type":"string"},"delivery_input_requirement_id":"example","field_path":"destination_address","purpose":"quote"}],"merchant_diagnostics":[{"code":"ELIGIBILITY_NO_MATCH","diagnostic_id":"example","occurred_at":"2026-08-02T16:00:00Z","outcome":"unavailable","recommended_action":"review_configuration","retryable":true,"scope":"method","summary":"example"}],"order_id":"ord_01K1P6G4M7H2N8Q9R3S5T6V7WX","selection_required":true,"status":"active"},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/CheckoutDeliveryQuoteResponse"}}},"description":"Checkout delivery quote.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create delivery quote","tags":["delivery_quotes"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CALCULATION_EXPIRED","DELIVERY_CALLER_RATES_UNAVAILABLE_TO_BUYER","DELIVERY_COMMERCE_TREATMENT_UNSUPPORTED","DELIVERY_DESTINATION_INVALID","DELIVERY_ELIGIBILITY_CONTEXT_CHANGED","DELIVERY_FIELD_NOT_SUPPORTED","DELIVERY_FIELD_REQUIRED","DELIVERY_GROUPING_UNSUPPORTED","DELIVERY_MERCHANT_INPUT_REQUIRED","DELIVERY_METHOD_SERVICE_UNAVAILABLE","DELIVERY_QUOTE_BASIS_INVALID","DELIVERY_QUOTE_EXPIRED","DELIVERY_QUOTE_INCOMPLETE","DELIVERY_QUOTE_INPUT_CHANGED","DELIVERY_QUOTE_INVALID","DELIVERY_QUOTE_REVOKED","DELIVERY_QUOTE_STALE","DELIVERY_QUOTE_UNAVAILABLE","DELIVERY_REQUEST_INVALID","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_WINDOW_EXPIRED","DELIVERY_WINDOW_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"delivery_quote"}},"/v1/checkout-sessions/{checkout_session_id}/delivery-quotes/{delivery_quote_id}":{"get":{"description":"Returns one quote under its checkout authority. Buyer credentials receive the buyer-safe projection.","operationId":"getCheckoutSessionDeliveryQuote","parameters":[{"description":"Flint checkout session ID.","in":"path","name":"checkout_session_id","required":true,"schema":{"type":"string"}},{"description":"Checkout session ID for buyer-facing checkout authentication.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret for buyer-facing checkout authentication.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"Flint delivery quote ID.","in":"path","name":"delivery_quote_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"audience":"merchant","checkout_session_id":"cs_01K1P6G4M7H2N8Q9R3S5T6V7WX","choice_groups":[{"availability_status":"ready","delivery_choice_group_id":"dcgrp_01K1P6G4M7H2N8Q9R3S5T6V7WX","evaluation_status":"complete","input_requirements":[{"constraint":{"type":"string"},"delivery_input_requirement_id":"example","field_path":"destination_address","purpose":"quote"}],"line_items":[{"order_line_item_id":"example","quantity":1}],"options":[{"amount_money":{"amount":0,"currency":"USD"},"buyer_instructions":{"enabled":true,"required":true},"delivery_method_id":"dmet_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_plan":{"type":"single_delivery"},"display_position":1,"name":"Standard delivery","recommended":true,"taxable":true,"type":"shipment","window_selection":"none"}],"stable_key":"example"}],"delivery_quote_id":"dqt_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_quote_revision":0,"eligibility_context_revision":0,"evaluated_at":"2026-08-02T16:00:00Z","evaluation_status":"complete","expires_at":"2026-08-02T16:00:00Z","input_requirements":[{"constraint":{"type":"string"},"delivery_input_requirement_id":"example","field_path":"destination_address","purpose":"quote"}],"merchant_diagnostics":[{"code":"ELIGIBILITY_NO_MATCH","diagnostic_id":"example","occurred_at":"2026-08-02T16:00:00Z","outcome":"unavailable","recommended_action":"review_configuration","retryable":true,"scope":"method","summary":"example"}],"order_id":"ord_01K1P6G4M7H2N8Q9R3S5T6V7WX","selection_required":true,"status":"active"},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/CheckoutDeliveryQuoteResponse"}}},"description":"Checkout delivery quote.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get checkout delivery quote","tags":["delivery_quotes"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CALCULATION_EXPIRED","DELIVERY_CALLER_RATES_UNAVAILABLE_TO_BUYER","DELIVERY_COMMERCE_TREATMENT_UNSUPPORTED","DELIVERY_DESTINATION_INVALID","DELIVERY_ELIGIBILITY_CONTEXT_CHANGED","DELIVERY_FIELD_NOT_SUPPORTED","DELIVERY_FIELD_REQUIRED","DELIVERY_GROUPING_UNSUPPORTED","DELIVERY_MERCHANT_INPUT_REQUIRED","DELIVERY_METHOD_SERVICE_UNAVAILABLE","DELIVERY_QUOTE_BASIS_INVALID","DELIVERY_QUOTE_EXPIRED","DELIVERY_QUOTE_INCOMPLETE","DELIVERY_QUOTE_INPUT_CHANGED","DELIVERY_QUOTE_INVALID","DELIVERY_QUOTE_REVOKED","DELIVERY_QUOTE_STALE","DELIVERY_QUOTE_UNAVAILABLE","DELIVERY_REQUEST_INVALID","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_WINDOW_EXPIRED","DELIVERY_WINDOW_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.read","commerce.delivery.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/checkout-sessions/{checkout_session_id}/delivery-selections":{"post":{"description":"Atomically selects one option per choice group, replaces inventory holds, and recalculates checkout economics.","operationId":"createCheckoutSessionDeliverySelection","parameters":[{"description":"Flint checkout session ID.","in":"path","name":"checkout_session_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Checkout session ID for buyer-facing checkout authentication.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret for buyer-facing checkout authentication.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"choices":[{"delivery_choice_group_id":"dcgrp_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_option_id":"dopt_01K1P6G4M7H2N8Q9R3S5T6V7WX"}],"delivery_quote_id":"dqt_01K1P6G4M7H2N8Q9R3S5T6V7WX","expected_delivery_selection_id":"example"},"schema":{"$ref":"#/components/schemas/CreateDeliverySelectionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"audience":"merchant","checkout_session":{"checkout_session_id":"cs_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_method_ids":["example"],"delivery_selection_required":true,"problems":[{"blocks_completion":true,"code":"delivery_selection_stale","severity":"error"}],"recovery_mode":true,"status":"open","surface":"hosted"},"delivery_selection":{"amount_money":{"amount":0,"currency":"USD"},"calculation_expires_at":"2026-08-02T16:00:00Z","checkout_session_id":"cs_01K1P6G4M7H2N8Q9R3S5T6V7WX","choices":[{"amount_money":{"amount":0,"currency":"USD"},"delivery_choice_group_id":"dcgrp_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_method_id":"dmet_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_option_id":"dopt_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_plan":{"type":"single_delivery"},"discount_money":{"amount":0,"currency":"USD"},"name":"Standard delivery","stable_key":"example","tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":0,"currency":"USD"},"type":"shipment"}],"created_at":"2026-08-02T16:00:00Z","delivery_quote_id":"dqt_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_quote_revision":0,"delivery_selection_id":"dsel_01K1P6G4M7H2N8Q9R3S5T6V7WX","eligibility_context_revision":0,"expires_at":"2026-08-02T16:00:00Z","lifecycle_updated_at":"2026-08-02T16:00:00Z","limiting_deadline_reason":"selection_guarantee_expiry","order_id":"ord_01K1P6G4M7H2N8Q9R3S5T6V7WX","status":"selected"},"order":{"line_items":[{"base_subtotal_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"Standard delivery","order_line_item_id":"example","quantity":1,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":1,"subtotal_money":{"amount":0,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":1,"currency":"USD"},"unit_price_money":{"amount":0,"currency":"USD"},"version":1}],"order_id":"ord_01K1P6G4M7H2N8Q9R3S5T6V7WX","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":0,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":0,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":1,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":0,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":true,"mode":"automatic","status":"not_required","taxability_reason":"standard_rated"}}},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/CheckoutDeliverySelectionResultResponse"}}},"description":"Committed delivery selection and authoritative checkout totals.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create delivery selection","tags":["delivery_selections"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_ELIGIBILITY_CONTEXT_CHANGED","DELIVERY_EXPECTED_SELECTION_REQUIRED","DELIVERY_EXTERNAL_REFERENCE_REUSED","DELIVERY_OPTION_ALREADY_SELECTED","DELIVERY_OPTION_EXPIRED","DELIVERY_OPTION_NOT_IN_CHOICE_GROUP","DELIVERY_QUOTE_EXPIRED","DELIVERY_QUOTE_INPUT_CHANGED","DELIVERY_QUOTE_REVOKED","DELIVERY_SELECTION_CHANGED","DELIVERY_SELECTION_EXPIRED","DELIVERY_SELECTION_INCOMPLETE","DELIVERY_SELECTION_NOT_MUTABLE_AFTER_PAYMENT","DELIVERY_SELECTION_REPLACEMENT_LIMIT","DELIVERY_SELECTION_UNAVAILABLE","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_WINDOW_EXPIRED","DELIVERY_WINDOW_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"delivery_selection"}},"/v1/checkout-sessions/{checkout_session_id}/delivery-selections/current":{"delete":{"description":"Atomically clears a provisional selection, releases inventory, removes its charges, and recalculates order economics.","operationId":"deleteCheckoutSessionCurrentDeliverySelection","parameters":[{"description":"Flint checkout session ID.","in":"path","name":"checkout_session_id","required":true,"schema":{"type":"string"}},{"description":"Checkout session ID for buyer-facing checkout authentication.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret for buyer-facing checkout authentication.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"Current delivery selection ID used as a compare-and-swap fence.","in":"query","name":"expected_delivery_selection_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"audience":"merchant","checkout_session":{"checkout_session_id":"cs_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_method_ids":["example"],"delivery_selection_required":true,"problems":[{"blocks_completion":true,"code":"delivery_selection_stale","severity":"error"}],"recovery_mode":true,"status":"open","surface":"hosted"},"delivery_selection":{"amount_money":{"amount":0,"currency":"USD"},"calculation_expires_at":"2026-08-02T16:00:00Z","checkout_session_id":"cs_01K1P6G4M7H2N8Q9R3S5T6V7WX","choices":[{"amount_money":{"amount":0,"currency":"USD"},"delivery_choice_group_id":"dcgrp_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_method_id":"dmet_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_option_id":"dopt_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_plan":{"type":"single_delivery"},"discount_money":{"amount":0,"currency":"USD"},"name":"Standard delivery","stable_key":"example","tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":0,"currency":"USD"},"type":"shipment"}],"created_at":"2026-08-02T16:00:00Z","delivery_quote_id":"dqt_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_quote_revision":0,"delivery_selection_id":"dsel_01K1P6G4M7H2N8Q9R3S5T6V7WX","eligibility_context_revision":0,"expires_at":"2026-08-02T16:00:00Z","lifecycle_updated_at":"2026-08-02T16:00:00Z","limiting_deadline_reason":"selection_guarantee_expiry","order_id":"ord_01K1P6G4M7H2N8Q9R3S5T6V7WX","status":"selected"},"order":{"line_items":[{"base_subtotal_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"Standard delivery","order_line_item_id":"example","quantity":1,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":1,"subtotal_money":{"amount":0,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":1,"currency":"USD"},"unit_price_money":{"amount":0,"currency":"USD"},"version":1}],"order_id":"ord_01K1P6G4M7H2N8Q9R3S5T6V7WX","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":0,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":0,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":1,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":0,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":true,"mode":"automatic","status":"not_required","taxability_reason":"standard_rated"}}},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/CheckoutDeliverySelectionResultResponse"}}},"description":"Released selection and authoritative checkout totals.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Delete current delivery selection","tags":["delivery_selections"],"x-flint-destructive":true,"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_ELIGIBILITY_CONTEXT_CHANGED","DELIVERY_EXPECTED_SELECTION_REQUIRED","DELIVERY_EXTERNAL_REFERENCE_REUSED","DELIVERY_OPTION_ALREADY_SELECTED","DELIVERY_OPTION_EXPIRED","DELIVERY_OPTION_NOT_IN_CHOICE_GROUP","DELIVERY_QUOTE_EXPIRED","DELIVERY_QUOTE_INPUT_CHANGED","DELIVERY_QUOTE_REVOKED","DELIVERY_SELECTION_CHANGED","DELIVERY_SELECTION_EXPIRED","DELIVERY_SELECTION_INCOMPLETE","DELIVERY_SELECTION_NOT_MUTABLE_AFTER_PAYMENT","DELIVERY_SELECTION_REPLACEMENT_LIMIT","DELIVERY_SELECTION_UNAVAILABLE","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_WINDOW_EXPIRED","DELIVERY_WINDOW_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"delivery_selection"},"get":{"description":"Returns the provisional selection or the order-level committed selection effective for this checkout.","operationId":"getCheckoutSessionCurrentDeliverySelection","parameters":[{"description":"Flint checkout session ID.","in":"path","name":"checkout_session_id","required":true,"schema":{"type":"string"}},{"description":"Checkout session ID for buyer-facing checkout authentication.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret for buyer-facing checkout authentication.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"audience":"merchant","mutable":true,"source":"none"},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/CheckoutEffectiveDeliverySelectionResponse"}}},"description":"Effective delivery selection.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get current delivery selection","tags":["delivery_selections"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_ELIGIBILITY_CONTEXT_CHANGED","DELIVERY_EXPECTED_SELECTION_REQUIRED","DELIVERY_EXTERNAL_REFERENCE_REUSED","DELIVERY_OPTION_ALREADY_SELECTED","DELIVERY_OPTION_EXPIRED","DELIVERY_OPTION_NOT_IN_CHOICE_GROUP","DELIVERY_QUOTE_EXPIRED","DELIVERY_QUOTE_INPUT_CHANGED","DELIVERY_QUOTE_REVOKED","DELIVERY_SELECTION_CHANGED","DELIVERY_SELECTION_EXPIRED","DELIVERY_SELECTION_INCOMPLETE","DELIVERY_SELECTION_REPLACEMENT_LIMIT","DELIVERY_SELECTION_UNAVAILABLE","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_WINDOW_EXPIRED","DELIVERY_WINDOW_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.read","commerce.delivery.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/checkout-sessions/{checkout_session_id}/delivery-selections/{delivery_selection_id}":{"get":{"description":"Returns one checkout selection with immutable economics, lifecycle events, and retention-aware private data.","operationId":"getCheckoutSessionDeliverySelectionHistory","parameters":[{"description":"Flint checkout session ID.","in":"path","name":"checkout_session_id","required":true,"schema":{"type":"string"}},{"description":"Flint delivery selection ID.","in":"path","name":"delivery_selection_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"amount_money":{"amount":0,"currency":"USD"},"calculation_expires_at":"2026-08-02T16:00:00Z","checkout_session_id":"cs_01K1P6G4M7H2N8Q9R3S5T6V7WX","choices":[{"amount_money":{"amount":0,"currency":"USD"},"delivery_choice_group_id":"dcgrp_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_method_id":"dmet_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_option_id":"dopt_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_plan":{"type":"single_delivery"},"discount_money":{"amount":0,"currency":"USD"},"name":"Standard delivery","stable_key":"example","tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":0,"currency":"USD"},"type":"shipment"}],"created_at":"2026-08-02T16:00:00Z","delivery_quote_id":"dqt_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_quote_revision":0,"delivery_selection_id":"dsel_01K1P6G4M7H2N8Q9R3S5T6V7WX","eligibility_context_revision":0,"expires_at":"2026-08-02T16:00:00Z","lifecycle_updated_at":"2026-08-02T16:00:00Z","limiting_deadline_reason":"selection_guarantee_expiry","order_id":"ord_01K1P6G4M7H2N8Q9R3S5T6V7WX","status":"selected"},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliverySelectionResponse"}}},"description":"Historical delivery selection.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get historical delivery selection","tags":["delivery_selections"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_ELIGIBILITY_CONTEXT_CHANGED","DELIVERY_EXPECTED_SELECTION_REQUIRED","DELIVERY_EXTERNAL_REFERENCE_REUSED","DELIVERY_OPTION_ALREADY_SELECTED","DELIVERY_OPTION_EXPIRED","DELIVERY_OPTION_NOT_IN_CHOICE_GROUP","DELIVERY_QUOTE_EXPIRED","DELIVERY_QUOTE_INPUT_CHANGED","DELIVERY_QUOTE_REVOKED","DELIVERY_SELECTION_CHANGED","DELIVERY_SELECTION_EXPIRED","DELIVERY_SELECTION_INCOMPLETE","DELIVERY_SELECTION_REPLACEMENT_LIMIT","DELIVERY_SELECTION_UNAVAILABLE","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_WINDOW_EXPIRED","DELIVERY_WINDOW_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.read","commerce.delivery.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/checkout-sessions/{checkout_session_id}/query-pickup-availability":{"post":{"description":"Computes a bounded, non-holding pickup-location projection from current checkout authority and one inventory snapshot. Merchant-authenticated requests include configured Location diagnostics; checkout credentials receive only buyer-safe results.","operationId":"queryCheckoutSessionPickupAvailability","parameters":[{"description":"Flint checkout session ID.","in":"path","name":"checkout_session_id","required":true,"schema":{"type":"string"}},{"description":"Checkout session ID for buyer-facing checkout authentication.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret for buyer-facing checkout authentication.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDeliveryPickupAvailabilityRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryPickupAvailabilityResponse"}}},"description":"Current pickup availability for the authenticated audience.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Query checkout pickup availability","tags":["checkout_sessions","delivery_quotes"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CALCULATION_EXPIRED","DELIVERY_CALLER_RATES_UNAVAILABLE_TO_BUYER","DELIVERY_COMMERCE_TREATMENT_UNSUPPORTED","DELIVERY_DESTINATION_INVALID","DELIVERY_ELIGIBILITY_CONTEXT_CHANGED","DELIVERY_FIELD_NOT_SUPPORTED","DELIVERY_FIELD_REQUIRED","DELIVERY_GROUPING_UNSUPPORTED","DELIVERY_MERCHANT_INPUT_REQUIRED","DELIVERY_METHOD_SERVICE_UNAVAILABLE","DELIVERY_PICKUP_AVAILABILITY_CHANGED","DELIVERY_PICKUP_AVAILABILITY_INVALID","DELIVERY_PICKUP_AVAILABILITY_UNAVAILABLE","DELIVERY_PICKUP_LOCATION_UNAVAILABLE","DELIVERY_QUOTE_BASIS_INVALID","DELIVERY_QUOTE_EXPIRED","DELIVERY_QUOTE_INCOMPLETE","DELIVERY_QUOTE_INPUT_CHANGED","DELIVERY_QUOTE_INVALID","DELIVERY_QUOTE_REVOKED","DELIVERY_QUOTE_STALE","DELIVERY_QUOTE_UNAVAILABLE","DELIVERY_REQUEST_INVALID","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_WINDOW_EXPIRED","DELIVERY_WINDOW_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.read","commerce.delivery.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"delivery_preview"}},"/v1/credit-notes":{"get":{"description":"Returns credit notes for the authenticated merchant, newest first. Filter by invoice_id to see everything credited against one invoice.","operationId":"listCreditNotes","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Page token.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by invoice.","in":"query","name":"invoice_id","required":false,"schema":{"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search across credit note ID, credit note number, memo, and external reference ID.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Filter by status.","in":"query","name":"status","required":false,"schema":{"enum":["draft","issued","void"],"type":"string","x-enum-descriptions":["Draft.","Issued.","Void."],"x-flint-enum":"open"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteListResponse"}}},"description":"A page of credit notes.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List credit notes","tags":["credit_notes"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_CREDIT_NOTE_STATUS","INVALID_PAGE_TOKEN","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.credit_notes.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.credit_notes.read","commerce.credit_notes.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates a draft credit note against an invoice that has been issued and not voided. Include credit_note_lines for initial corrections or omit them for an empty draft. The draft uses the invoice currency and receives a credit note number when issued.","operationId":"createCreditNote","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreditNoteRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteResponse"}}},"description":"The created resource.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note state conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create credit note","tags":["credit_notes"],"x-flint-error-codes":["AUTH_REQUIRED","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_CREDIT_NOTE_MEMO","INVALID_CREDIT_NOTE_REASON","INVALID_REQUEST","INVOICE_NOT_CREDITABLE","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.credit_notes.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.credit_notes.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/credit-notes/{credit_note_id}":{"get":{"description":"Returns one credit note with its lines, total, and the credit still available to allocate.","operationId":"getCreditNote","parameters":[{"description":"Flint credit note ID.","in":"path","name":"credit_note_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteResponse"}}},"description":"The credit note.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get credit note","tags":["credit_notes"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.credit_notes.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.credit_notes.read","commerce.credit_notes.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Updates draft credit note fields and corrections atomically. Omitted fields are unchanged, a null memo clears it, and credit_note_lines requires expected_version. Issued and void credit notes are frozen.","operationId":"updateCreditNote","parameters":[{"description":"Flint credit note ID.","in":"path","name":"credit_note_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCreditNoteRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteResponse"}}},"description":"The updated credit note.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note state conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update credit note","tags":["credit_notes"],"x-flint-error-codes":["AUTH_REQUIRED","CREDIT_NOTE_CHANGED","CREDIT_NOTE_NOT_DRAFT","EMPTY_UPDATE","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_CREDIT_NOTE_MEMO","INVALID_CREDIT_NOTE_REASON","INVALID_EXPECTED_VERSION","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.credit_notes.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.credit_notes.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/credit-notes/{credit_note_id}/allocations":{"get":{"description":"Returns every allocation made from a credit note, including reversed ones. Filter by idempotency_key to find the allocation a given request produced.","operationId":"listCreditNoteAllocations","parameters":[{"description":"Flint credit note ID.","in":"path","name":"credit_note_id","required":true,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Page token.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by caller key.","in":"query","name":"idempotency_key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteAllocationListResponse"}}},"description":"A page of allocations.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List credit note allocations","tags":["credit_notes"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_PAGE_TOKEN","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.credit_notes.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.credit_notes.read","commerce.credit_notes.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Applies credit from an issued credit note to its invoice, reducing outstanding_money. The amount cannot exceed the credit note's unallocated_money or the invoice's outstanding balance. Closing the balance with credit sets the invoice to credited. Returns the allocation, the credit note, and the recomputed invoice together. An Idempotency-Key is required and becomes the allocation's identity.","operationId":"createCreditNoteAllocation","parameters":[{"description":"Flint credit note ID.","in":"path","name":"credit_note_id","required":true,"schema":{"type":"string"}},{"description":"Required caller-chosen command identity. Reuse it when retrying the same allocation.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreditNoteAllocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteAllocationResultResponse"}}},"description":"The created resource.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note state conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Allocate credit note","tags":["credit_notes"],"x-flint-error-codes":["AUTH_REQUIRED","CREDIT_NOTE_ALLOCATION_EXCEEDS_BALANCE","CREDIT_NOTE_CHANGED","CREDIT_NOTE_NOT_ISSUED","CURRENCY_MISMATCH","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REQUIRED","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_AMOUNT","INVALID_CURRENCY","INVALID_EXPECTED_VERSION","INVALID_REQUEST","INVOICE_PAYMENT_RESOLVING","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.credit_notes.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.credit_notes.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/credit-notes/{credit_note_id}/allocations/{credit_note_allocation_id}":{"get":{"description":"Returns one allocation. A non-null reversed_at means the credit was returned to the credit note and the invoice balance reopened.","operationId":"getCreditNoteAllocation","parameters":[{"description":"Flint credit note ID.","in":"path","name":"credit_note_id","required":true,"schema":{"type":"string"}},{"description":"Flint credit note allocation ID.","in":"path","name":"credit_note_allocation_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteAllocationResponse"}}},"description":"The allocation.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get credit note allocation","tags":["credit_notes"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.credit_notes.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.credit_notes.read","commerce.credit_notes.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/credit-notes/{credit_note_id}/allocations/{credit_note_allocation_id}/reverse":{"post":{"description":"Reverses an allocation and reopens that much of the invoice balance. The original allocation keeps its row and gains reversed_at, so the history stays append-only. Reversing the allocation that closed an invoice moves it from credited back to open or partially_paid.","operationId":"reverseCreditNoteAllocation","parameters":[{"description":"Flint credit note ID.","in":"path","name":"credit_note_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Flint credit note allocation ID.","in":"path","name":"credit_note_allocation_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceVersionRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteAllocationResultResponse"}}},"description":"The updated resource.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note state conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Reverse credit note allocation","tags":["credit_notes"],"x-flint-error-codes":["AUTH_REQUIRED","CREDIT_NOTE_ALLOCATION_ALREADY_REVERSED","CREDIT_NOTE_CHANGED","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_EXPECTED_VERSION","INVALID_REQUEST","INVOICE_PAYMENT_RESOLVING","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.credit_notes.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.credit_notes.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/credit-notes/{credit_note_id}/issue":{"post":{"description":"Issues a draft credit note and freezes its PDF. Optionally provide refund to initiate a linked refund on a paid invoice. With refund, Idempotency-Key is required and retained for the lifetime of the refund command, scoped to merchant, environment, credit note, and key. Reuse the key with the identical request to recover the original result. Use the credit note refunds list filtered by idempotency_key after a lost response. A pending refund is accepted, not completed. Without refund, issuance does not move money.","operationId":"issueCreditNote","parameters":[{"description":"Flint credit note ID.","in":"path","name":"credit_note_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueCreditNoteRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueCreditNoteResponse"}}},"description":"The updated credit note.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note state conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Issue credit note","tags":["credit_notes"],"x-flint-error-codes":["AUTH_REQUIRED","CREDIT_NOTE_ALLOCATION_EXCEEDS_BALANCE","CREDIT_NOTE_CHANGED","CREDIT_NOTE_REFUND_INVALID","IDEMPOTENCY_KEY_REQUIRED","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_EXPECTED_VERSION","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.credit_notes.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.credit_notes.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/credit-notes/{credit_note_id}/pdf":{"get":{"description":"Returns the credit note document as application/pdf rather than a JSON envelope. The PDF exists from issue onward and carries your branding, the credited lines, and the invoice it corrects.","operationId":"getCreditNotePDF","parameters":[{"description":"Flint credit note ID.","in":"path","name":"credit_note_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/pdf":{}},"description":"A PDF document.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Download credit note PDF","tags":["credit_notes"],"x-flint-error-codes":["AUTH_REQUIRED","CREDIT_NOTE_NOT_ISSUED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.credit_notes.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.credit_notes.read","commerce.credit_notes.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/credit-notes/{credit_note_id}/refunds":{"get":{"description":"Lists linked refunds, including failed attempts, newest first. Filter by idempotency_key to recover a refund after a lost response.","operationId":"listCreditNoteRefunds","parameters":[{"description":"Flint credit note ID.","in":"path","name":"credit_note_id","required":true,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Page token.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by caller key.","in":"query","name":"idempotency_key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteRefundListResponse"}}},"description":"A page of refunds.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List credit note refunds","tags":["credit_notes"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.credit_notes.read","commerce.refunds.read"],"x-flint-partner-required-scopes-mode":"all","x-flint-required-scopes":["commerce.credit_notes.read","commerce.credit_notes.write","commerce.refunds.read","commerce.refunds.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"read"},"post":{"description":"Creates a refund against an issued credit note on a paid invoice. Omit amount_money to refund all available credit. Refunds use the source invoice's original payments and do not reopen its balance. Idempotency-Key is required and retained for the lifetime of the refund command, scoped to merchant, environment, credit note, and key. Reusing it with another request conflicts. Recover a lost response by listing this note's refunds with idempotency_key. A failed remainder can be requested with a new key after its outcome is definitive.","operationId":"createCreditNoteRefund","parameters":[{"description":"Flint credit note ID.","in":"path","name":"credit_note_id","required":true,"schema":{"type":"string"}},{"description":"Required caller-chosen command identity. Reuse it when retrying the same allocation.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCreditNoteRefundRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundResponse"}}},"description":"The created resource.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note state conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Refund credit note","tags":["credit_notes"],"x-flint-error-codes":["AUTH_REQUIRED","CREDIT_NOTE_ALLOCATION_EXCEEDS_BALANCE","CREDIT_NOTE_CHANGED","CREDIT_NOTE_REFUND_INVALID","IDEMPOTENCY_KEY_REQUIRED","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_EXPECTED_VERSION","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.credit_notes.write","commerce.refunds.write"],"x-flint-partner-required-scopes-mode":"all","x-flint-required-scopes":["commerce.credit_notes.write","commerce.refunds.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/credit-notes/{credit_note_id}/void":{"post":{"description":"Voids an issued credit note. Every allocation has to be reversed first. Void is terminal, and an invoice cannot be voided while an issued credit note stands against it.","operationId":"voidCreditNote","parameters":[{"description":"Flint credit note ID.","in":"path","name":"credit_note_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceVersionRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditNoteResponse"}}},"description":"The updated resource.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note state conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Void credit note","tags":["credit_notes"],"x-flint-error-codes":["AUTH_REQUIRED","CREDIT_NOTE_CHANGED","CREDIT_NOTE_HAS_ALLOCATIONS","CREDIT_NOTE_NOT_ISSUED","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_EXPECTED_VERSION","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.credit_notes.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.credit_notes.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/customer-deletion-requests":{"get":{"description":"Lists deletion requests across the selected merchant environment so a merchant can discover and review buyer-created requests.","operationId":"listCustomerDeletionRequests","parameters":[{"description":"Only return requests in this lifecycle state.","in":"query","name":"status","required":false,"schema":{"enum":["pending_review","processing","completed","rejected","failed"],"type":"string","x-enum-descriptions":["Pending review.","Processing.","Completed.","Rejected.","Failed."],"x-flint-enum":"open"}},{"description":"Only return requests for this Flint customer ID.","in":"query","name":"customer_id","required":false,"schema":{"type":"string"}},{"description":"Number of deletion requests to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque token returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDeletionRequestListResponse"}}},"description":"The matching deletion requests.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer account resources are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List customer deletion requests","tags":["customers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["customers.read","customers.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/customer-deletion-requests/{customer_deletion_request_id}/resolve":{"post":{"description":"Approves or rejects a pending deletion request. Approval returns processing while account data and buyer credentials are deleted asynchronously. A failed deletion can be approved again but cannot be rejected. Approval is blocked while the customer has non-canceled subscriptions or usable saved payment methods.","operationId":"resolveCustomerDeletionRequest","parameters":[{"description":"Flint customer deletion request ID.","in":"path","name":"customer_deletion_request_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolveCustomerDeletionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDeletionRequestResponse"}}},"description":"The updated deletion request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer account resources are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Resolve a customer deletion request","tags":["customers"],"x-flint-error-codes":["AUTH_REQUIRED","CUSTOMER_ACCOUNT_RESOURCE_NOT_FOUND","CUSTOMER_DELETION_BLOCKED","INSUFFICIENT_SCOPE","INVALID_CUSTOMER_ACCOUNT_REQUEST","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["customers.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/customer-sessions":{"post":{"description":"Mints a server-side, customer-scoped credential after the merchant has authenticated the buyer. Secret and refresh_token are returned only in this response. Flint-hosted merchants also receive a separately expiring one-time account_url.","operationId":"createCustomerSession","parameters":[{"description":"Optional idempotency key for safe retries. Flint generates and returns one when omitted.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomerSessionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerSessionResponse"}}},"description":"The customer session and one-time credentials.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid customer session request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The API key does not have customers.sessions.write.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer or customer session not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Idempotency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer sessions are temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create a customer session","tags":["customer_sessions"],"x-flint-error-codes":["AUTH_REQUIRED","CUSTOMER_SESSIONS_UNAVAILABLE","CUSTOMER_SESSION_NOT_FOUND","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_CUSTOMER_SESSION","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["customers.sessions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/customer-sessions/refresh":{"post":{"description":"Rotates a customer session secret and refresh token without a merchant API key. Reusing a rotated refresh token revokes the session family.","operationId":"refreshCustomerSession","parameters":[{"description":"Required durable key for safe refresh retries. Reuse it with the same refresh token until a response is received.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshCustomerSessionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerSessionResponse"}}},"description":"The rotated customer session credentials.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The refresh token is expired, invalid, or was reused.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer sessions are temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[],"summary":"Refresh a customer session","tags":["customer_sessions"],"x-flint-error-codes":["AUTH_REQUIRED","CUSTOMER_SESSIONS_UNAVAILABLE","CUSTOMER_SESSION_REFRESH_EXPIRED","CUSTOMER_SESSION_REFRESH_REUSED","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REQUIRED","IDEMPOTENCY_KEY_REUSED","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"sensitive_write"}},"/v1/customer-sessions/{customer_session_id}/revoke":{"post":{"description":"Revokes one customer session. This does not revoke an independent Flint Account buyer session.","operationId":"revokeCustomerSession","parameters":[{"description":"Flint customer session ID.","in":"path","name":"customer_session_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries. Flint generates and returns one when omitted.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerSessionRevocationResponse"}}},"description":"The revocation result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid customer session request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The API key does not have customers.sessions.write.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer or customer session not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Idempotency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer sessions are temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Revoke a customer session","tags":["customer_sessions"],"x-flint-error-codes":["AUTH_REQUIRED","CUSTOMER_SESSIONS_UNAVAILABLE","CUSTOMER_SESSION_NOT_FOUND","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["customers.sessions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/customers":{"get":{"description":"Returns a paginated list of customers for the authenticated merchant.","operationId":"listCustomers","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Search across customer name, email, phone number, and external_reference_id.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Exact-match filter on email address.","in":"query","name":"email","required":false,"schema":{"type":"string"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["name","email","created_at","updated_at"],"type":"string","x-enum-descriptions":["Name.","Email.","Created at.","Updated at."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"RFC3339 lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 lower bound for updated_at.","in":"query","name":"updated_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for updated_at.","in":"query","name":"updated_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Supported expansions: receivables. Supported expansion: receivables. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=receivables\u0026expand=receivables, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["receivables"],"type":"string","x-enum-descriptions":["Receivables."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Customer list","value":{"data":[{"billing_address":{"city":"New York","country":"US","line1":"123 Main St","postal_code":"10001","state":"NY"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","email":"jane@example.com","group_id":"vip","is_verified":true,"merchant_id":"mer_123","metadata":{"crm_id":"crm_123"},"name":"Jane Doe","phone":"+14155552671","tax_exempt":true,"tax_identity":null,"updated_at":"2026-03-17T14:30:00Z","version":0}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Customer list with expanded receivables","value":{"data":[{"billing_address":{"city":"New York","country":"US","line1":"123 Main St","postal_code":"10001","state":"NY"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","default_payment_method":{"card":{"brand":"visa","exp_month":12,"exp_year":2030,"last4":"4242"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","payment_method_id":"pm_123","status":"active","type":"card","updated_at":"2026-03-17T14:30:00Z"},"default_payment_method_id":"pm_123","email":"jane@example.com","group_id":"vip","is_verified":true,"merchant_id":"mer_123","metadata":{"crm_id":"crm_123"},"name":"Jane Doe","phone":"+14155552671","receivables":{"balances":[{"currency":"USD","outstanding_money":{"amount":12500,"currency":"USD"},"overdue_money":{"amount":2500,"currency":"USD"}}],"observed_at":"2026-03-17T14:30:00Z"},"tax_exempt":true,"tax_identity":null,"updated_at":"2026-03-17T14:30:00Z","version":0}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/CustomerListResponse"}}},"description":"A page of customers.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List customers","tags":["customers"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["customers.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["customers.read","customers.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates a customer for the authenticated merchant.","operationId":"createCustomer","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"billing_address":{"city":"New York","country":"US","line1":"123 Main St","postal_code":"10001","state":"NY"},"email":"jane@example.com","metadata":{"crm_id":"crm_123"},"name":"Jane Doe"},"schema":{"$ref":"#/components/schemas/CreateCustomerRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"billing_address":{"city":"New York","country":"US","line1":"123 Main St","postal_code":"10001","state":"NY"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","email":"jane@example.com","group_id":"vip","is_verified":true,"merchant_id":"mer_123","metadata":{"crm_id":"crm_123"},"name":"Jane Doe","phone":"+14155552671","tax_exempt":true,"tax_identity":null,"updated_at":"2026-03-17T14:30:00Z","version":0},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CustomerResponse"}}},"description":"The created customer.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create customer","tags":["customers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["customers.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["customers.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/customers/{customer_id}":{"get":{"description":"Returns a single customer by ID.","operationId":"getCustomer","parameters":[{"description":"Flint customer ID.","in":"path","name":"customer_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: default_payment_method, receivables. Expanding the default payment method requires customers.read plus payments.payment_methods.read. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=default_payment_method\u0026expand=receivables, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["default_payment_method","receivables"],"type":"string","x-enum-descriptions":["Default payment method.","Receivables."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Customer","value":{"data":{"billing_address":{"city":"New York","country":"US","line1":"123 Main St","postal_code":"10001","state":"NY"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","email":"jane@example.com","group_id":"vip","is_verified":true,"merchant_id":"mer_123","metadata":{"crm_id":"crm_123"},"name":"Jane Doe","phone":"+14155552671","tax_exempt":true,"tax_identity":null,"updated_at":"2026-03-17T14:30:00Z","version":0},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Customer with expanded default payment method","value":{"data":{"billing_address":{"city":"New York","country":"US","line1":"123 Main St","postal_code":"10001","state":"NY"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","default_payment_method":{"card":{"brand":"visa","exp_month":12,"exp_year":2030,"last4":"4242"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","payment_method_id":"pm_123","status":"active","type":"card","updated_at":"2026-03-17T14:30:00Z"},"default_payment_method_id":"pm_123","email":"jane@example.com","group_id":"vip","is_verified":true,"merchant_id":"mer_123","metadata":{"crm_id":"crm_123"},"name":"Jane Doe","phone":"+14155552671","receivables":{"balances":[{"currency":"USD","outstanding_money":{"amount":12500,"currency":"USD"},"overdue_money":{"amount":2500,"currency":"USD"}}],"observed_at":"2026-03-17T14:30:00Z"},"tax_exempt":true,"tax_identity":null,"updated_at":"2026-03-17T14:30:00Z","version":0},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/CustomerResponse"}}},"description":"The requested customer.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"customer not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get customer","tags":["customers"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["customers.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["customers.read","customers.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Applies a sparse update to a customer. Writing billing_address or shipping_address clears the corresponding saved-address default, so that field remains effective until another saved default is selected.","operationId":"updateCustomer","parameters":[{"description":"Flint customer ID.","in":"path","name":"customer_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"internal_note":"VIP buyer","metadata":{"segment":"vip"},"phone":"+14155552671"},"schema":{"$ref":"#/components/schemas/UpdateCustomerRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"billing_address":{"city":"New York","country":"US","line1":"123 Main St","postal_code":"10001","state":"NY"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","email":"jane@example.com","group_id":"vip","is_verified":true,"merchant_id":"mer_123","metadata":{"crm_id":"crm_123"},"name":"Jane Doe","phone":"+14155552671","tax_exempt":true,"tax_identity":null,"updated_at":"2026-03-17T14:30:00Z","version":0},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CustomerResponse"}}},"description":"The updated customer.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update customer","tags":["customers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["customers.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["customers.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/customers/{customer_id}/addresses":{"get":{"description":"Lists the customer's saved addresses with billing and shipping default flags.","operationId":"listCustomerAddresses","parameters":[{"description":"Flint customer ID.","in":"path","name":"customer_id","required":true,"schema":{"type":"string"}},{"description":"Number of addresses to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque token returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddressListResponse"}}},"description":"The customer's addresses.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer account resources are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List customer addresses","tags":["customers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["customers.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["customers.read","customers.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates a stable saved address. The first address becomes both the billing and shipping default. A saved default becomes the customer's effective address for the corresponding role.","operationId":"createCustomerAddress","parameters":[{"description":"Flint customer ID.","in":"path","name":"customer_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomerAddressRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddressResponse"}}},"description":"The created address.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer account resources are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create a customer address","tags":["customers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["customers.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["customers.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/customers/{customer_id}/addresses/{customer_address_id}":{"delete":{"description":"Deletes a saved address and moves any default designation to the newest remaining address.","operationId":"deleteCustomerAddress","parameters":[{"description":"Flint customer ID.","in":"path","name":"customer_id","required":true,"schema":{"type":"string"}},{"description":"Flint customer address ID.","in":"path","name":"customer_address_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionResponse"}}},"description":"The address was deleted.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer account resources are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Delete a customer address","tags":["customers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["customers.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["customers.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Returns one saved address owned by the customer.","operationId":"getCustomerAddress","parameters":[{"description":"Flint customer ID.","in":"path","name":"customer_id","required":true,"schema":{"type":"string"}},{"description":"Flint customer address ID.","in":"path","name":"customer_address_id","required":true,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddressResponse"}}},"description":"The requested address.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer account resources are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get a customer address","tags":["customers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["customers.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["customers.read","customers.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Applies a sparse update to a saved address. Updating a default address also updates the customer's effective address for that role.","operationId":"updateCustomerAddress","parameters":[{"description":"Flint customer ID.","in":"path","name":"customer_id","required":true,"schema":{"type":"string"}},{"description":"Flint customer address ID.","in":"path","name":"customer_address_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCustomerAddressRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddressResponse"}}},"description":"The updated address.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer account resources are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update a customer address","tags":["customers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["customers.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["customers.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/customers/{customer_id}/addresses/{customer_address_id}/set-default":{"post":{"description":"Sets the address as the billing default, shipping default, or both and makes it the customer's effective address for each selected role.","operationId":"setDefaultCustomerAddress","parameters":[{"description":"Flint customer ID.","in":"path","name":"customer_id","required":true,"schema":{"type":"string"}},{"description":"Flint customer address ID.","in":"path","name":"customer_address_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetDefaultCustomerAddressRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddressResponse"}}},"description":"The default address.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer account resources are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Set a default customer address","tags":["customers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["customers.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["customers.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/customers/{customer_id}/deletion-requests":{"post":{"description":"Creates or returns the pending tracked deletion request. Required commerce records are retained until the deletion workflow resolves their legal retention requirements.","operationId":"createCustomerDeletionRequest","parameters":[{"description":"Flint customer ID.","in":"path","name":"customer_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDeletionRequestResponse"}}},"description":"The tracked deletion request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer account resources are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Request customer account deletion","tags":["customers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["customers.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/customers/{customer_id}/deletion-requests/{customer_deletion_request_id}":{"get":{"description":"Returns the current status of a tracked deletion request.","operationId":"getCustomerDeletionRequest","parameters":[{"description":"Flint customer ID.","in":"path","name":"customer_id","required":true,"schema":{"type":"string"}},{"description":"Flint customer deletion request ID.","in":"path","name":"customer_deletion_request_id","required":true,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDeletionRequestResponse"}}},"description":"The tracked deletion request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer account resources are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get a customer deletion request","tags":["customers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["customers.read","customers.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/customers/{customer_id}/sessions/revoke":{"post":{"description":"Revokes every customer session for one customer in the selected merchant environment. Flint Account buyer sessions remain independent.","operationId":"revokeCustomerSessions","parameters":[{"description":"Flint customer ID.","in":"path","name":"customer_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries. Flint generates and returns one when omitted.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerSessionsRevocationResponse"}}},"description":"The number of newly revoked sessions.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid customer session request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The API key does not have customers.sessions.write.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer or customer session not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Idempotency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer sessions are temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Revoke a customer's sessions","tags":["customer_sessions"],"x-flint-error-codes":["AUTH_REQUIRED","CUSTOMER_SESSIONS_UNAVAILABLE","CUSTOMER_SESSION_NOT_FOUND","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["customers.sessions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/delivery-location-sets":{"get":{"description":"Returns delivery location sets in a stable, cursor-paginated order.","operationId":"listDeliveryLocationSets","parameters":[{"description":"Number of resources to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by Flint ID, name, or external reference ID. Delivery methods also match their description.","in":"query","name":"query","required":false,"schema":{"maxLength":255,"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Filter by lifecycle status.","in":"query","name":"status","required":false,"schema":{"enum":["inactive","active","archived","revoked"],"type":"string","x-enum-descriptions":["Inactive.","Active.","Archived.","Revoked."],"x-flint-enum":"open"}},{"description":"Filter by an active current method that references this resource.","in":"query","name":"delivery_method_id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"configuration":{"location_ids":["example"]},"created_at":"2026-08-02T16:00:00Z","current_delivery_location_set_revision_id":"dlsr_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_location_set_id":"dls_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1}],"next_page_token":"page_2","request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryLocationSetListResponse"}}},"description":"Delivery configuration page.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List delivery location sets","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.read","commerce.delivery.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Delivery location sets pin reusable sets of Locations for allocation or buyer pickup. Creation publishes immutable revision 1. It starts active.","operationId":"createDeliveryLocationSet","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"configuration":{"location_ids":["example"]},"name":"Standard delivery"},"schema":{"$ref":"#/components/schemas/CreateDeliveryLocationSetRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"configuration":{"location_ids":["example"]},"created_at":"2026-08-02T16:00:00Z","current_delivery_location_set_revision_id":"dlsr_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_location_set_id":"dls_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryLocationSetResponse"}}},"description":"Created delivery location set.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create delivery location set","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/delivery-location-sets/{delivery_location_set_id}":{"delete":{"description":"Retires the delivery location set after checking current dependencies. The retired resource remains available by ID for historical records.","operationId":"deleteDeliveryLocationSet","parameters":[{"description":"Flint delivery location set ID.","in":"path","name":"delivery_location_set_id","required":true,"schema":{"type":"string"}},{"description":"Optional current resource version. The delete is rejected if the resource changed after this version was read.","in":"query","name":"expected_version","required":false,"schema":{"format":"uint64","minimum":1,"type":"integer"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"configuration":{"location_ids":["example"]},"created_at":"2026-08-02T16:00:00Z","current_delivery_location_set_revision_id":"dlsr_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_location_set_id":"dls_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryLocationSetResponse"}}},"description":"Retired delivery location set.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Delete delivery location set","tags":["delivery_configuration"],"x-flint-destructive":true,"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Returns the current revision and lifecycle state for one delivery location set.","operationId":"getDeliveryLocationSet","parameters":[{"description":"Flint delivery location set ID.","in":"path","name":"delivery_location_set_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"configuration":{"location_ids":["example"]},"created_at":"2026-08-02T16:00:00Z","current_delivery_location_set_revision_id":"dlsr_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_location_set_id":"dls_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryLocationSetResponse"}}},"description":"Delivery resource.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get delivery location set","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.read","commerce.delivery.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Sparsely updates mutable fields. A change to pinned configuration publishes a new immutable revision and requires expected_version.","operationId":"updateDeliveryLocationSet","parameters":[{"description":"Flint delivery location set ID.","in":"path","name":"delivery_location_set_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{},"schema":{"$ref":"#/components/schemas/UpdateDeliveryLocationSetRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"configuration":{"location_ids":["example"]},"created_at":"2026-08-02T16:00:00Z","current_delivery_location_set_revision_id":"dlsr_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_location_set_id":"dls_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryLocationSetResponse"}}},"description":"Updated delivery location set.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update delivery location set","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/delivery-methods":{"get":{"description":"Returns delivery methods in a stable, cursor-paginated order.","operationId":"listDeliveryMethods","parameters":[{"description":"Number of resources to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by Flint ID, name, or external reference ID. Delivery methods also match their description.","in":"query","name":"query","required":false,"schema":{"maxLength":255,"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Filter by lifecycle status.","in":"query","name":"status","required":false,"schema":{"enum":["inactive","active","archived","revoked"],"type":"string","x-enum-descriptions":["Inactive.","Active.","Archived.","Revoked."],"x-flint-enum":"open"}},{"description":"Filter by method type.","in":"query","name":"type","required":false,"schema":{"enum":["shipment","local_delivery","pickup"],"type":"string","x-enum-descriptions":["Shipment.","Local delivery.","Pickup."],"x-flint-enum":"closed"}},{"description":"Filter by referenced delivery zone.","in":"query","name":"delivery_zone_id","required":false,"schema":{"type":"string"}},{"description":"Filter by referenced delivery location set.","in":"query","name":"delivery_location_set_id","required":false,"schema":{"type":"string"}},{"description":"Filter by referenced callback endpoint.","in":"query","name":"delivery_rate_callback_id","required":false,"schema":{"type":"string"}},{"description":"Filter by referenced Location.","in":"query","name":"location_id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"configuration":{"charge_tax_category":"service_fee","estimate":{"type":"none"},"minimum_option_lifetime_seconds":0,"offer_windows":true,"origin":{"location_id":"loc_01K1P6G4M7H2N8Q9R3S5T6V7WX","type":"fixed_location"},"pricing":{"calculated":{},"type":"calculated"},"selection_guarantee_seconds":0},"created_at":"2026-08-02T16:00:00Z","current_delivery_method_revision_id":"dmetr_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_method_id":"dmet_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1}],"next_page_token":"page_2","request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryMethodListResponse"}}},"description":"Delivery configuration page.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List delivery methods","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.read","commerce.delivery.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Delivery methods combine eligibility, pricing, schedules, estimates, tax treatment, and execution behavior. Creation publishes immutable revision 1. Omit status to start inactive.","operationId":"createDeliveryMethod","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"configuration":{"origin":{"location_id":"loc_01K1P6G4M7H2N8Q9R3S5T6V7WX","type":"fixed_location"},"pricing":{"calculated":{},"type":"calculated"}},"type":"shipment"},"schema":{"$ref":"#/components/schemas/CreateDeliveryMethodRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"configuration":{"charge_tax_category":"service_fee","estimate":{"type":"none"},"minimum_option_lifetime_seconds":0,"offer_windows":true,"origin":{"location_id":"loc_01K1P6G4M7H2N8Q9R3S5T6V7WX","type":"fixed_location"},"pricing":{"calculated":{},"type":"calculated"},"selection_guarantee_seconds":0},"created_at":"2026-08-02T16:00:00Z","current_delivery_method_revision_id":"dmetr_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_method_id":"dmet_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryMethodResponse"}}},"description":"Created delivery method.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create delivery method","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","DELIVERY_STATUS_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/delivery-methods/{delivery_method_id}":{"delete":{"description":"Retires the delivery method after checking current dependencies. The retired resource remains available by ID for historical records.","operationId":"deleteDeliveryMethod","parameters":[{"description":"Flint delivery method ID.","in":"path","name":"delivery_method_id","required":true,"schema":{"type":"string"}},{"description":"Optional current resource version. The delete is rejected if the resource changed after this version was read.","in":"query","name":"expected_version","required":false,"schema":{"format":"uint64","minimum":1,"type":"integer"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"configuration":{"charge_tax_category":"service_fee","estimate":{"type":"none"},"minimum_option_lifetime_seconds":0,"offer_windows":true,"origin":{"location_id":"loc_01K1P6G4M7H2N8Q9R3S5T6V7WX","type":"fixed_location"},"pricing":{"calculated":{},"type":"calculated"},"selection_guarantee_seconds":0},"created_at":"2026-08-02T16:00:00Z","current_delivery_method_revision_id":"dmetr_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_method_id":"dmet_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryMethodResponse"}}},"description":"Retired delivery method.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Delete delivery method","tags":["delivery_configuration"],"x-flint-destructive":true,"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Returns the current revision and lifecycle state for one delivery method.","operationId":"getDeliveryMethod","parameters":[{"description":"Flint delivery method ID.","in":"path","name":"delivery_method_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"configuration":{"charge_tax_category":"service_fee","estimate":{"type":"none"},"minimum_option_lifetime_seconds":0,"offer_windows":true,"origin":{"location_id":"loc_01K1P6G4M7H2N8Q9R3S5T6V7WX","type":"fixed_location"},"pricing":{"calculated":{},"type":"calculated"},"selection_guarantee_seconds":0},"created_at":"2026-08-02T16:00:00Z","current_delivery_method_revision_id":"dmetr_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_method_id":"dmet_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryMethodResponse"}}},"description":"Delivery resource.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get delivery method","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.read","commerce.delivery.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Sparsely updates mutable fields. A change to pinned configuration publishes a new immutable revision and requires expected_version.","operationId":"updateDeliveryMethod","parameters":[{"description":"Flint delivery method ID.","in":"path","name":"delivery_method_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{},"schema":{"$ref":"#/components/schemas/UpdateDeliveryMethodRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"configuration":{"charge_tax_category":"service_fee","estimate":{"type":"none"},"minimum_option_lifetime_seconds":0,"offer_windows":true,"origin":{"location_id":"loc_01K1P6G4M7H2N8Q9R3S5T6V7WX","type":"fixed_location"},"pricing":{"calculated":{},"type":"calculated"},"selection_guarantee_seconds":0},"created_at":"2026-08-02T16:00:00Z","current_delivery_method_revision_id":"dmetr_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_method_id":"dmet_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryMethodResponse"}}},"description":"Updated delivery method.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update delivery method","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/delivery-previews":{"post":{"description":"Computes exact display-only delivery outcomes without persisting a resource, holding inventory, or granting selection authority.","operationId":"createDeliveryPreview","parameters":[{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"currency":"USD","delivery_method_ids":["example"],"line_items":[{"variant_id":"example"}]},"schema":{"$ref":"#/components/schemas/CreateDeliveryPreviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"choice_groups":[{"availability_status":"ready","candidate_outcomes":{},"evaluation_status":"complete","input_requirements":[{"constraint":{"type":"string"},"delivery_input_requirement_id":"example","field_path":"destination_address","purpose":"quote"}],"line_items":[{"order_line_item_id":"example","quantity":1}],"options":[{"amount_money":{"amount":0,"currency":"USD"},"buyer_instructions":{"enabled":true,"required":true},"delivery_method_id":"dmet_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_plan":{"type":"single_delivery"},"display_position":1,"name":"Standard delivery","recommended":true,"taxable":true,"type":"shipment","window_selection":"none"}]}],"currency":"USD","delivery_method_ids":["example"],"evaluated_at":"2026-08-02T16:00:00Z","evaluation_status":"complete","expires_at":"2026-08-02T16:00:00Z","input_requirements":[{"constraint":{"type":"string"},"delivery_input_requirement_id":"example","field_path":"destination_address","purpose":"quote"}],"line_items":[{"variant_id":"example"}],"merchant_diagnostics":[{"code":"ELIGIBILITY_NO_MATCH","diagnostic_id":"example","occurred_at":"2026-08-02T16:00:00Z","outcome":"unavailable","recommended_action":"review_configuration","retryable":true,"scope":"method","summary":"example"}],"selection_authority":true},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryPreviewResponse"}}},"description":"Exact non-selectable delivery preview.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create delivery preview","tags":["delivery_previews"],"x-flint-error-codes":["AUTH_REQUIRED","AUTOMATIC_TAX_COMPONENTS_FORBIDDEN","AUTOMATIC_TAX_MULTIPLE_DESTINATIONS","AUTOMATIC_TAX_MULTIPLE_ORIGINS","AUTOMATIC_TAX_POST_TAX_DISCOUNT_UNSUPPORTED","BUNDLE_NOT_SELLABLE","CATALOG_INVENTORY_RELATIONSHIP_INVALID","CATALOG_LINE_ITEM_CURRENCY_CHANGED","CATALOG_LINE_ITEM_FIELDS_READ_ONLY","CATALOG_LINE_ITEM_SOURCE_CHANGED","CHECKOUT_TAX_CALCULATION_LIMIT_REACHED","CURRENCY_MISMATCH","DELIVERY_DESTINATION_INVALID","DELIVERY_PREVIEW_INVALID","DELIVERY_PREVIEW_METHOD_TYPES_INCOMPATIBLE","DELIVERY_PREVIEW_REQUIRES_CHECKOUT","DELIVERY_PREVIEW_UNAVAILABLE","DELIVERY_SERVICE_UNAVAILABLE","DUPLICATE_TAX_COMPONENT","EXTERNAL_TAX_COMPONENTS_REQUIRED","FIELD_REQUIRED","FLAT_TAX_SCOPE_INVALID","FULFILLMENT_BUNDLE_UNSUPPORTED","FULFILLMENT_CONFIGURATION_ACTION_REQUIRED","FULFILLMENT_PROFILE_REVISION_UNUSABLE","FULFILLMENT_REQUIREMENT_REQUIRED","INSUFFICIENT_SCOPE","INVALID_CURRENCY","INVALID_FIELD_TYPE","INVALID_FULFILLMENT_REQUIREMENT","INVALID_ID","INVALID_LINE_ITEMS","INVALID_METADATA_KEY","INVALID_REQUEST","INVALID_TAX_CALCULATION_TYPE","INVALID_TAX_CATEGORY","INVALID_TAX_JURISDICTION","INVALID_TAX_PERCENTAGE","INVALID_TAX_PRICE_MODE","INVALID_TAX_TYPE","INVALID_TOTALS","INVENTORY_DEMAND_DUPLICATE","INVENTORY_DEMAND_INVALID","INVENTORY_ROUTING_SOURCE_REQUIRED","LINE_ITEM_INVALID_QUANTITY","LINE_ITEM_NAME_REQUIRED","LINE_ITEM_NAME_TOO_LONG","LINE_ITEM_NEGATIVE_PRICE","LINE_ITEM_PRICE_REQUIRED","LINE_ITEM_QUANTITY_TOO_LARGE","LINE_ITEM_SOURCE_CONFLICT","LINE_ITEM_UNIT_PRICE_REQUIRED","METADATA_KEY_TOO_LONG","METADATA_TOO_LARGE","METADATA_TOO_MANY_KEYS","METADATA_VALUE_TOO_LONG","MODIFIER_CURRENCY_MISMATCH","MODIFIER_DUPLICATE_SELECTION","MODIFIER_GROUP_REQUIRED","MODIFIER_QUANTITY_INVALID","MODIFIER_SELECTION_LIMIT_EXCEEDED","MODIFIER_SOURCE_UNSUPPORTED","MODIFIER_TEXT_INVALID","MODIFIER_UNAVAILABLE","NULL_NOT_ALLOWED","ORDER_LINE_ITEM_TAX_INPUT_REQUIRED","ORDER_TAX_CALCULATION_FAILED","ORDER_TAX_RATE_UNAVAILABLE","ORDER_TAX_UNSUPPORTED_COUNTRY","PRODUCT_LINE_ITEM_SOURCE_UNSUPPORTED","PROMOTION_CONFLICT","PROMOTION_DECLINED","RATE_LIMIT_EXCEEDED","RESERVED_METADATA_KEY","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TAX_CALCULATION_REQUIRED","TAX_MODE_MISMATCH","TOO_MANY_LINE_ITEMS","UNKNOWN_FIELD","UNSUPPORTED_CURRENCY","VARIANT_NOT_SELLABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"delivery_preview"}},"/v1/delivery-profiles":{"get":{"description":"Returns delivery profiles in a stable, cursor-paginated order.","operationId":"listDeliveryProfiles","parameters":[{"description":"Number of resources to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by Flint ID, name, or external reference ID. Delivery methods also match their description.","in":"query","name":"query","required":false,"schema":{"maxLength":255,"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Filter by lifecycle status.","in":"query","name":"status","required":false,"schema":{"enum":["inactive","active","archived","revoked"],"type":"string","x-enum-descriptions":["Inactive.","Active.","Archived.","Revoked."],"x-flint-enum":"open"}},{"description":"Filter by profile resolution mode.","in":"query","name":"resolution_mode","required":false,"schema":{"enum":["quote","manual"],"type":"string","x-enum-descriptions":["Quote.","Manual."],"x-flint-enum":"closed"}},{"description":"Compute catalog and delivery-configuration diagnostics for every profile returned.","in":"query","name":"include_diagnostics","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"configuration":{"requirement":"none"},"created_at":"2026-08-02T16:00:00Z","current_delivery_profile_revision_id":"dprofr_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_profile_id":"dprof_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1}],"next_page_token":"page_2","request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryProfileListResponse"}}},"description":"Delivery configuration page.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List delivery profiles","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_BOOLEAN","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.read","commerce.delivery.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Delivery profiles define reusable delivery rules assigned to catalog obligations. Creation publishes immutable revision 1. It starts active.","operationId":"createDeliveryProfile","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"configuration":{"requirement":"none"},"name":"Standard delivery"},"schema":{"$ref":"#/components/schemas/CreateDeliveryProfileRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"configuration":{"requirement":"none"},"created_at":"2026-08-02T16:00:00Z","current_delivery_profile_revision_id":"dprofr_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_profile_id":"dprof_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryProfileResponse"}}},"description":"Created delivery profile.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create delivery profile","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/delivery-profiles/{delivery_profile_id}":{"delete":{"description":"Retires the delivery profile after checking current dependencies. The retired resource remains available by ID for historical records.","operationId":"deleteDeliveryProfile","parameters":[{"description":"Flint delivery profile ID.","in":"path","name":"delivery_profile_id","required":true,"schema":{"type":"string"}},{"description":"Optional current resource version. The delete is rejected if the resource changed after this version was read.","in":"query","name":"expected_version","required":false,"schema":{"format":"uint64","minimum":1,"type":"integer"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"configuration":{"requirement":"none"},"created_at":"2026-08-02T16:00:00Z","current_delivery_profile_revision_id":"dprofr_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_profile_id":"dprof_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryProfileResponse"}}},"description":"Retired delivery profile.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Delete delivery profile","tags":["delivery_configuration"],"x-flint-destructive":true,"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Returns the current revision and lifecycle state for one delivery profile.","operationId":"getDeliveryProfile","parameters":[{"description":"Flint delivery profile ID.","in":"path","name":"delivery_profile_id","required":true,"schema":{"type":"string"}},{"description":"Compute catalog and delivery-configuration diagnostics for this profile.","in":"query","name":"include_diagnostics","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"configuration":{"requirement":"none"},"created_at":"2026-08-02T16:00:00Z","current_delivery_profile_revision_id":"dprofr_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_profile_id":"dprof_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryProfileResponse"}}},"description":"Delivery resource.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get delivery profile","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_BOOLEAN","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.read","commerce.delivery.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Sparsely updates mutable fields. A change to pinned configuration publishes a new immutable revision and requires expected_version.","operationId":"updateDeliveryProfile","parameters":[{"description":"Flint delivery profile ID.","in":"path","name":"delivery_profile_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{},"schema":{"$ref":"#/components/schemas/UpdateDeliveryProfileRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"configuration":{"requirement":"none"},"created_at":"2026-08-02T16:00:00Z","current_delivery_profile_revision_id":"dprofr_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_profile_id":"dprof_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryProfileResponse"}}},"description":"Updated delivery profile.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update delivery profile","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/delivery-profiles/{delivery_profile_id}/assign-to-unconfigured":{"post":{"description":"Assigns this active delivery profile to physical product variants and bundle components that do not have a delivery profile.","operationId":"assignToUnconfiguredDeliveryProfile","parameters":[{"description":"Flint delivery profile ID.","in":"path","name":"delivery_profile_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{},"schema":{"$ref":"#/components/schemas/AssignToUnconfiguredDeliveryProfileRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"bundle_components_updated":0,"delivery_profile_id":"dprof_01K1P6G4M7H2N8Q9R3S5T6V7WX","product_variants_updated":0},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryProfileAssignmentResponse"}}},"description":"Counts of catalog entries assigned to the delivery profile.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Assign unconfigured catalog entries","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","SETTINGS_CONCURRENT_MODIFICATION"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/delivery-quotes":{"get":{"description":"Returns persisted delivery quote diagnostics in stable creation order.","operationId":"listDeliveryQuotes","parameters":[{"description":"Filter by checkout session.","in":"query","name":"checkout_session_id","required":false,"schema":{"type":"string"}},{"description":"Filter by order.","in":"query","name":"order_id","required":false,"schema":{"type":"string"}},{"description":"Filter by lifecycle status.","in":"query","name":"status","required":false,"schema":{"enum":["active","consumed","stale","expired","revoked"],"type":"string","x-enum-descriptions":["Active.","Consumed.","Stale.","Expired.","Revoked."],"x-flint-enum":"open"}},{"description":"Filter by evaluation status.","in":"query","name":"evaluation_status","required":false,"schema":{"enum":["complete","incomplete","degraded"],"type":"string","x-enum-descriptions":["Complete.","Incomplete.","Degraded."],"x-flint-enum":"open"}},{"description":"Inclusive RFC 3339 creation lower bound.","in":"query","name":"created_after","required":false,"schema":{"type":"string"}},{"description":"Inclusive RFC 3339 creation upper bound.","in":"query","name":"created_before","required":false,"schema":{"type":"string"}},{"description":"Number of quotes to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque cursor from the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"audience":"merchant","checkout_session_id":"cs_01K1P6G4M7H2N8Q9R3S5T6V7WX","choice_groups":[{"availability_status":"ready","delivery_choice_group_id":"dcgrp_01K1P6G4M7H2N8Q9R3S5T6V7WX","evaluation_status":"complete","input_requirements":[{"constraint":{"type":"string"},"delivery_input_requirement_id":"example","field_path":"destination_address","purpose":"quote"}],"line_items":[{"order_line_item_id":"example","quantity":1}],"options":[{"amount_money":{"amount":0,"currency":"USD"},"buyer_instructions":{"enabled":true,"required":true},"delivery_method_id":"dmet_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_plan":{"type":"single_delivery"},"display_position":1,"name":"Standard delivery","recommended":true,"taxable":true,"type":"shipment","window_selection":"none"}],"stable_key":"example"}],"delivery_quote_id":"dqt_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_quote_revision":0,"eligibility_context_revision":0,"evaluated_at":"2026-08-02T16:00:00Z","evaluation_status":"complete","expires_at":"2026-08-02T16:00:00Z","input_requirements":[{"constraint":{"type":"string"},"delivery_input_requirement_id":"example","field_path":"destination_address","purpose":"quote"}],"merchant_diagnostics":[{"code":"ELIGIBILITY_NO_MATCH","diagnostic_id":"example","occurred_at":"2026-08-02T16:00:00Z","outcome":"unavailable","recommended_action":"review_configuration","retryable":true,"scope":"method","summary":"example"}],"order_id":"ord_01K1P6G4M7H2N8Q9R3S5T6V7WX","selection_required":true,"status":"active"}],"next_page_token":"page_2","request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryQuoteListResponse"}}},"description":"Delivery quote page.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List delivery quotes","tags":["delivery_quotes"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CALCULATION_EXPIRED","DELIVERY_CALLER_RATES_UNAVAILABLE_TO_BUYER","DELIVERY_COMMERCE_TREATMENT_UNSUPPORTED","DELIVERY_DESTINATION_INVALID","DELIVERY_ELIGIBILITY_CONTEXT_CHANGED","DELIVERY_FIELD_NOT_SUPPORTED","DELIVERY_FIELD_REQUIRED","DELIVERY_GROUPING_UNSUPPORTED","DELIVERY_MERCHANT_INPUT_REQUIRED","DELIVERY_METHOD_SERVICE_UNAVAILABLE","DELIVERY_QUOTE_BASIS_INVALID","DELIVERY_QUOTE_EXPIRED","DELIVERY_QUOTE_INCOMPLETE","DELIVERY_QUOTE_INPUT_CHANGED","DELIVERY_QUOTE_INVALID","DELIVERY_QUOTE_REVOKED","DELIVERY_QUOTE_STALE","DELIVERY_QUOTE_UNAVAILABLE","DELIVERY_REQUEST_INVALID","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_WINDOW_EXPIRED","DELIVERY_WINDOW_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.read","commerce.delivery.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/delivery-rate-callbacks":{"get":{"description":"Returns delivery rate callbacks in a stable, cursor-paginated order.","operationId":"listDeliveryRateCallbacks","parameters":[{"description":"Number of resources to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by Flint ID, name, or external reference ID. Delivery methods also match their description.","in":"query","name":"query","required":false,"schema":{"maxLength":255,"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Filter by lifecycle status.","in":"query","name":"status","required":false,"schema":{"enum":["inactive","active","archived","revoked"],"type":"string","x-enum-descriptions":["Inactive.","Active.","Archived.","Revoked."],"x-flint-enum":"open"}},{"description":"Filter by an active current method that references this resource.","in":"query","name":"delivery_method_id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"circuit_failure_count":0,"circuit_state":"closed","configuration":{"url":"https://merchant.example/delivery"},"created_at":"2026-08-02T16:00:00Z","current_delivery_rate_callback_revision_id":"dcbr_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_rate_callback_id":"dcb_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1}],"next_page_token":"page_2","request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryRateCallbackListResponse"}}},"description":"Delivery configuration page.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List delivery rate callbacks","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.read","commerce.delivery.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Delivery callback endpoints pin shared outbound callback transport configuration. Creation publishes immutable revision 1. It starts inactive.","operationId":"createDeliveryRateCallback","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"configuration":{"url":"https://merchant.example/delivery"},"name":"Standard delivery"},"schema":{"$ref":"#/components/schemas/CreateDeliveryRateCallbackRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"circuit_failure_count":0,"circuit_state":"closed","configuration":{"url":"https://merchant.example/delivery"},"created_at":"2026-08-02T16:00:00Z","current_delivery_rate_callback_revision_id":"dcbr_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_rate_callback_id":"dcb_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryRateCallbackResponse"}}},"description":"Created delivery rate callback.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create delivery rate callback","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/delivery-rate-callbacks/{delivery_rate_callback_id}":{"delete":{"description":"Retires the delivery rate callback after checking current dependencies. The retired resource remains available by ID for historical records.","operationId":"deleteDeliveryRateCallback","parameters":[{"description":"Flint delivery rate callback ID.","in":"path","name":"delivery_rate_callback_id","required":true,"schema":{"type":"string"}},{"description":"Optional current resource version. The delete is rejected if the resource changed after this version was read.","in":"query","name":"expected_version","required":false,"schema":{"format":"uint64","minimum":1,"type":"integer"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"circuit_failure_count":0,"circuit_state":"closed","configuration":{"url":"https://merchant.example/delivery"},"created_at":"2026-08-02T16:00:00Z","current_delivery_rate_callback_revision_id":"dcbr_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_rate_callback_id":"dcb_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryRateCallbackResponse"}}},"description":"Retired delivery rate callback.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Delete delivery rate callback","tags":["delivery_configuration"],"x-flint-destructive":true,"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Returns the current revision and lifecycle state for one delivery rate callback.","operationId":"getDeliveryRateCallback","parameters":[{"description":"Flint delivery rate callback ID.","in":"path","name":"delivery_rate_callback_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"circuit_failure_count":0,"circuit_state":"closed","configuration":{"url":"https://merchant.example/delivery"},"created_at":"2026-08-02T16:00:00Z","current_delivery_rate_callback_revision_id":"dcbr_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_rate_callback_id":"dcb_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryRateCallbackResponse"}}},"description":"Delivery resource.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get delivery rate callback","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.read","commerce.delivery.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Sparsely updates mutable fields. A change to pinned configuration publishes a new immutable revision and requires expected_version.","operationId":"updateDeliveryRateCallback","parameters":[{"description":"Flint delivery rate callback ID.","in":"path","name":"delivery_rate_callback_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{},"schema":{"$ref":"#/components/schemas/UpdateDeliveryRateCallbackRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"circuit_failure_count":0,"circuit_state":"closed","configuration":{"url":"https://merchant.example/delivery"},"created_at":"2026-08-02T16:00:00Z","current_delivery_rate_callback_revision_id":"dcbr_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_rate_callback_id":"dcb_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryRateCallbackResponse"}}},"description":"Updated delivery rate callback.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update delivery rate callback","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/delivery-rate-callbacks/{delivery_rate_callback_id}/check-connection":{"post":{"description":"Sends a minimal signed probe to verify endpoint reachability and callback credentials without running a synthetic rate evaluation.","operationId":"checkDeliveryRateCallbackConnection","parameters":[{"description":"Flint delivery rate callback ID.","in":"path","name":"delivery_rate_callback_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"201":{"content":{"application/json":{"example":{"data":{"checked_at":"2026-08-02T16:00:00Z","delivery_rate_callback_id":"dcb_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_rate_callback_revision_id":"dcbr_01K1P6G4M7H2N8Q9R3S5T6V7WX","key_id":"example","latency_milliseconds":1,"status":"succeeded"},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryRateCallbackConnectionCheckResponse"}}},"description":"Created callback connection-check result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Check delivery rate callback connection","tags":["delivery_configuration"],"x-flint-cli-action":"check-connection","x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/delivery-rate-callbacks/{delivery_rate_callback_id}/rotate-secret":{"post":{"description":"Rotates the endpoint signing secret, accepts both keys for one hour, and returns the new secret once.","operationId":"rotateDeliveryRateCallbackSigningKey","parameters":[{"description":"Flint delivery rate callback ID.","in":"path","name":"delivery_rate_callback_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"201":{"content":{"application/json":{"example":{"data":{"delivery_rate_callback_id":"dcb_01K1P6G4M7H2N8Q9R3S5T6V7WX","key_id":"example","secret":"example"},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryRateCallbackSigningKeyRotationResponse"}}},"description":"Created signing-key rotation.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Rotate delivery rate callback signing key","tags":["delivery_configuration"],"x-flint-cli-action":"rotate-secret","x-flint-destructive":true,"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/delivery-rate-callbacks/{delivery_rate_callback_id}/test-deliveries":{"post":{"description":"Sends a signed delivery rate callback with synthetic non-PII data and returns a safe result.","operationId":"createDeliveryRateCallbackTestDelivery","parameters":[{"description":"Flint delivery rate callback ID.","in":"path","name":"delivery_rate_callback_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"201":{"content":{"application/json":{"example":{"data":{"delivery_rate_callback_id":"dcb_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_rate_callback_revision_id":"dcbr_01K1P6G4M7H2N8Q9R3S5T6V7WX","key_id":"example","latency_milliseconds":1,"status":"succeeded","tested_at":"2026-08-02T16:00:00Z"},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryRateCallbackTestDeliveryResponse"}}},"description":"Created callback test-delivery result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Test delivery rate callback","tags":["delivery_configuration"],"x-flint-cli-action":"test-deliveries","x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/delivery-revocations":{"post":{"description":"Permanently fences one exact method, endpoint, signing key, revision, or Location geography version. Issued quotes are revoked immediately. Current selections are released the next time they are read. Stable method and callback-endpoint targets require expected_version so a concurrent publication cannot broaden the revocation.","operationId":"revokeDeliveryDependency","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"reason":"unsafe_configuration","target":{"location_geography_revision":1,"location_id":"loc_01K1P6G4M7H2N8Q9R3S5T6V7WX","target_type":"location_geography"}},"schema":{"$ref":"#/components/schemas/RevokeDeliveryDependencyRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"created_at":"2026-08-02T16:00:00Z","delivery_revocation_id":"example","estimated_impact":{"active_quote_count":1,"current_selection_count":1},"reason":"unsafe_configuration","target":{"location_geography_revision":1,"location_id":"loc_01K1P6G4M7H2N8Q9R3S5T6V7WX","target_type":"location_geography"}},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryRevocationResponse"}}},"description":"Created emergency revocation.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Revoke delivery dependency","tags":["delivery_revocations"],"x-flint-destructive":true,"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_DEPENDENCY_REVOKED","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_SERVICE_UNAVAILABLE","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/delivery-revocations/{delivery_revocation_id}":{"get":{"description":"Returns one permanent delivery revocation and its estimated impact at creation time.","operationId":"getDeliveryRevocation","parameters":[{"description":"Flint delivery revocation ID.","in":"path","name":"delivery_revocation_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-08-02T16:00:00Z","delivery_revocation_id":"example","estimated_impact":{"active_quote_count":1,"current_selection_count":1},"reason":"unsafe_configuration","target":{"location_geography_revision":1,"location_id":"loc_01K1P6G4M7H2N8Q9R3S5T6V7WX","target_type":"location_geography"}},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryRevocationResponse"}}},"description":"Delivery revocation.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get delivery revocation","tags":["delivery_revocations"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_DEPENDENCY_REVOKED","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_SERVICE_UNAVAILABLE","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.read","commerce.delivery.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/delivery-zones":{"get":{"description":"Returns delivery zones in a stable, cursor-paginated order.","operationId":"listDeliveryZones","parameters":[{"description":"Number of resources to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by Flint ID, name, or external reference ID. Delivery methods also match their description.","in":"query","name":"query","required":false,"schema":{"maxLength":255,"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Filter by lifecycle status.","in":"query","name":"status","required":false,"schema":{"enum":["inactive","active","archived","revoked"],"type":"string","x-enum-descriptions":["Inactive.","Active.","Archived.","Revoked."],"x-flint-enum":"open"}},{"description":"Filter by an active current method that references this resource.","in":"query","name":"delivery_method_id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"configuration":{"country":{"values":["example"]}},"created_at":"2026-08-02T16:00:00Z","current_delivery_zone_revision_id":"dzoner_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_zone_id":"dzone_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1}],"next_page_token":"page_2","request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryZoneListResponse"}}},"description":"Delivery configuration page.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List delivery zones","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.read","commerce.delivery.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Delivery zones define versioned geographic eligibility. Creation publishes immutable revision 1. It starts active.","operationId":"createDeliveryZone","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"configuration":{"country":{"values":["example"]}},"name":"Standard delivery"},"schema":{"$ref":"#/components/schemas/CreateDeliveryZoneRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"configuration":{"country":{"values":["example"]}},"created_at":"2026-08-02T16:00:00Z","current_delivery_zone_revision_id":"dzoner_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_zone_id":"dzone_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryZoneResponse"}}},"description":"Created delivery zone.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create delivery zone","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/delivery-zones/{delivery_zone_id}":{"delete":{"description":"Retires the delivery zone after checking current dependencies. The retired resource remains available by ID for historical records.","operationId":"deleteDeliveryZone","parameters":[{"description":"Flint delivery zone ID.","in":"path","name":"delivery_zone_id","required":true,"schema":{"type":"string"}},{"description":"Optional current resource version. The delete is rejected if the resource changed after this version was read.","in":"query","name":"expected_version","required":false,"schema":{"format":"uint64","minimum":1,"type":"integer"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"configuration":{"country":{"values":["example"]}},"created_at":"2026-08-02T16:00:00Z","current_delivery_zone_revision_id":"dzoner_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_zone_id":"dzone_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryZoneResponse"}}},"description":"Retired delivery zone.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Delete delivery zone","tags":["delivery_configuration"],"x-flint-destructive":true,"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Returns the current revision and lifecycle state for one delivery zone.","operationId":"getDeliveryZone","parameters":[{"description":"Flint delivery zone ID.","in":"path","name":"delivery_zone_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"configuration":{"country":{"values":["example"]}},"created_at":"2026-08-02T16:00:00Z","current_delivery_zone_revision_id":"dzoner_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_zone_id":"dzone_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryZoneResponse"}}},"description":"Delivery resource.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get delivery zone","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.read","commerce.delivery.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Sparsely updates mutable fields. A change to pinned configuration publishes a new immutable revision and requires expected_version.","operationId":"updateDeliveryZone","parameters":[{"description":"Flint delivery zone ID.","in":"path","name":"delivery_zone_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{},"schema":{"$ref":"#/components/schemas/UpdateDeliveryZoneRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"configuration":{"country":{"values":["example"]}},"created_at":"2026-08-02T16:00:00Z","current_delivery_zone_revision_id":"dzoner_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_zone_id":"dzone_01K1P6G4M7H2N8Q9R3S5T6V7WX","name":"Standard delivery","status":"inactive","updated_at":"2026-08-02T16:00:00Z","version":1},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliveryZoneResponse"}}},"description":"Updated delivery zone.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Version, lifecycle, or dependency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update delivery zone","tags":["delivery_configuration"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_CONFIGURATION_INVALID","DELIVERY_EXPECTED_VERSION_INVALID","DELIVERY_EXPECTED_VERSION_REQUIRED","DELIVERY_RESOURCE_HAS_DEPENDENCIES","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_RESOURCE_VERSION_CONFLICT","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_STATE_CONFLICT","DELIVERY_STATUS_COMBINATION_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.delivery.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.delivery.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/demo-sessions":{"post":{"description":"Creates a temporary demo sandbox and returns a short-lived test API key. The secret key is displayed only at creation time and for a short idempotent retry window.","operationId":"createDemoSession","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Turnstile challenge token from the landing page.","in":"header","name":"X-Turnstile-Token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"template":"quickstart"},"schema":{"$ref":"#/components/schemas/CreateDemoSessionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"api_key":{"scopes":["commerce.products.read","customers.read","customers.write"],"secret_key":"flint_test_demo_0123456789abcdef0123456789abcdef0123456789abcdef"},"demo_session_id":"demo_01JQDEMOSESSION1234567890","expires_at":"2026-03-18T20:30:00Z","sandbox_id":"test_01JQDEMOSESSION12345678"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/DemoSessionResponse"}}},"description":"The created demo session and temporary API key.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Idempotency conflict or existing active demo session.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Demo sessions are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[],"summary":"Create demo session","tags":["demo_sessions"],"x-flint-error-codes":["INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"sensitive_write"}},"/v1/demo-sessions/reset":{"post":{"description":"Ends the caller's current demo sandbox (if any) and provisions a fresh one, returning a new temporary API key. Useful when the original one-time secret was lost. Subject to the same per-client daily limit as creation.","operationId":"resetDemoSession","parameters":[{"description":"Turnstile challenge token from the landing page.","in":"header","name":"X-Turnstile-Token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"template":"quickstart"},"schema":{"$ref":"#/components/schemas/CreateDemoSessionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"api_key":{"scopes":["commerce.products.read","customers.read","customers.write"],"secret_key":"flint_test_demo_0123456789abcdef0123456789abcdef0123456789abcdef"},"demo_session_id":"demo_01JQDEMOSESSION1234567890","expires_at":"2026-03-18T20:30:00Z","sandbox_id":"test_01JQDEMOSESSION12345678"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/DemoSessionResponse"}}},"description":"The freshly provisioned demo session and temporary API key.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Demo sessions are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[],"summary":"Reset demo session","tags":["demo_sessions"],"x-flint-error-codes":["INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"sensitive_write"}},"/v1/developer/auth-context":{"get":{"description":"Returns non-secret metadata for an API key or CLI OAuth access token, including its merchant, environment, sandbox binding, and granted scopes. CLI OAuth sessions include auth_type=oauth and a stable oauth_grant_id instead of api_key_id. Multi-context tokens also include oauth_session_id, context_id, and the context name. No additional API scope is required.","operationId":"getDeveloperAuthContext","parameters":[{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"api_key_id":"key_123","auth_type":"api_key","environment":"sandbox","merchant_id":"mer_123","name":"local-dev","organization_id":"org_123","sandbox_id":"test_123","scopes":["payments.payment_intents.read"]},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/DeveloperAuthContextResponse"}}},"description":"The current API key or CLI OAuth authentication context.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"API key metadata is unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get the current authentication context","tags":["developer_logs"],"x-flint-error-codes":["AUTH_REQUIRED","INVALID_API_KEY","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/developer/partner/apps":{"get":{"description":"Returns partner apps owned by the authenticated merchant.","operationId":"listDeveloperPartnerApps","parameters":[{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"allowed_scopes":["commerce.bundles.read","commerce.bundles.write","commerce.catalog.read","commerce.orders.read","commerce.orders.write","commerce.products.read","customers.read","customers.write"],"api_version":"2026-09-07","app_type":"plugin","client_id":"fpc_1234567890abcdef1234567890abcd","created_at":"2026-03-18T20:00:00Z","default_requested_permissions":["manage_orders"],"name":"Acme Commerce Plugin","partner_app_id":"papp_01JQPARTNERAPP1234567890","permission_manifest":[{"description":"Read and update Flint orders for installed merchants.","permission_id":"manage_orders","required_scopes":["commerce.orders.read","commerce.orders.write"],"title":"Manage orders"},{"description":"Read and update customer records for installed merchants.","optional":true,"permission_id":"manage_customers","required_scopes":["customers.read","customers.write"],"title":"Manage customers"},{"description":"Read product, variant, bundle, and SKU lookup catalog records.","optional":true,"permission_id":"read_catalog","required_scopes":["commerce.products.read","commerce.bundles.read","commerce.catalog.read"],"title":"Read catalog"},{"description":"Create and update bundle catalog records for installed merchants.","optional":true,"permission_id":"manage_bundles","required_scopes":["commerce.bundles.write"],"title":"Manage bundles"}],"redirect_uris":["https://plugins.acme.com/flint/oauth/callback","http://localhost:3000/flint/oauth/callback"],"status":"active","updated_at":"2026-03-18T20:00:00Z","visibility":"private"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PartnerAppListResponse"}}},"description":"Partner apps for the authenticated merchant.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"OnboardingSessionBearer":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List partner apps","tags":["partner_apps"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["developer.partner_apps.read","developer.partner_apps.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates a partner app owned by the authenticated merchant. Use a developer setup session during setup or a normal external API key afterward.","operationId":"createDeveloperPartnerApp","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"app_type":"plugin","default_requested_permissions":["manage_orders"],"name":"Acme Commerce Plugin","permission_manifest":[{"description":"Read and update Flint orders for installed merchants.","permission_id":"manage_orders","required_scopes":["commerce.orders.read","commerce.orders.write"],"title":"Manage orders"},{"description":"Read and update customer records for installed merchants.","optional":true,"permission_id":"manage_customers","required_scopes":["customers.read","customers.write"],"title":"Manage customers"},{"description":"Read product, variant, bundle, and SKU lookup catalog records.","optional":true,"permission_id":"read_catalog","required_scopes":["commerce.products.read","commerce.bundles.read","commerce.catalog.read"],"title":"Read catalog"},{"description":"Create and update bundle catalog records for installed merchants.","optional":true,"permission_id":"manage_bundles","required_scopes":["commerce.bundles.write"],"title":"Manage bundles"}],"redirect_uris":["https://plugins.acme.com/flint/oauth/callback","http://localhost:3000/flint/oauth/callback"],"visibility":"private"},"schema":{"$ref":"#/components/schemas/CreatePartnerAppRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"allowed_scopes":["commerce.bundles.read","commerce.bundles.write","commerce.catalog.read","commerce.orders.read","commerce.orders.write","commerce.products.read","customers.read","customers.write"],"api_version":"2026-09-07","app_type":"plugin","client_id":"fpc_1234567890abcdef1234567890abcd","client_secret":"fps_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcd","created_at":"2026-03-18T20:00:00Z","default_requested_permissions":["manage_orders"],"name":"Acme Commerce Plugin","partner_app_id":"papp_01JQPARTNERAPP1234567890","permission_manifest":[{"description":"Read and update Flint orders for installed merchants.","permission_id":"manage_orders","required_scopes":["commerce.orders.read","commerce.orders.write"],"title":"Manage orders"},{"description":"Read and update customer records for installed merchants.","optional":true,"permission_id":"manage_customers","required_scopes":["customers.read","customers.write"],"title":"Manage customers"},{"description":"Read product, variant, bundle, and SKU lookup catalog records.","optional":true,"permission_id":"read_catalog","required_scopes":["commerce.products.read","commerce.bundles.read","commerce.catalog.read"],"title":"Read catalog"},{"description":"Create and update bundle catalog records for installed merchants.","optional":true,"permission_id":"manage_bundles","required_scopes":["commerce.bundles.write"],"title":"Manage bundles"}],"redirect_uris":["https://plugins.acme.com/flint/oauth/callback","http://localhost:3000/flint/oauth/callback"],"status":"active","updated_at":"2026-03-18T20:00:00Z","visibility":"private"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CreatePartnerAppResponse"}}},"description":"The created partner app. client_secret is only returned once.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"OnboardingSessionBearer":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create partner app","tags":["partner_apps"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["developer.partner_apps.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/developer/partner/apps/{partner_app_id}":{"get":{"description":"Returns a single partner app owned by the authenticated merchant.","operationId":"getDeveloperPartnerApp","parameters":[{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Flint partner app ID.","in":"path","name":"partner_app_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"allowed_scopes":["commerce.bundles.read","commerce.bundles.write","commerce.catalog.read","commerce.orders.read","commerce.orders.write","commerce.products.read","customers.read","customers.write"],"api_version":"2026-09-07","app_type":"plugin","client_id":"fpc_1234567890abcdef1234567890abcd","created_at":"2026-03-18T20:00:00Z","default_requested_permissions":["manage_orders"],"name":"Acme Commerce Plugin","partner_app_id":"papp_01JQPARTNERAPP1234567890","permission_manifest":[{"description":"Read and update Flint orders for installed merchants.","permission_id":"manage_orders","required_scopes":["commerce.orders.read","commerce.orders.write"],"title":"Manage orders"},{"description":"Read and update customer records for installed merchants.","optional":true,"permission_id":"manage_customers","required_scopes":["customers.read","customers.write"],"title":"Manage customers"},{"description":"Read product, variant, bundle, and SKU lookup catalog records.","optional":true,"permission_id":"read_catalog","required_scopes":["commerce.products.read","commerce.bundles.read","commerce.catalog.read"],"title":"Read catalog"},{"description":"Create and update bundle catalog records for installed merchants.","optional":true,"permission_id":"manage_bundles","required_scopes":["commerce.bundles.write"],"title":"Manage bundles"}],"redirect_uris":["https://plugins.acme.com/flint/oauth/callback","http://localhost:3000/flint/oauth/callback"],"status":"active","updated_at":"2026-03-18T20:00:00Z","visibility":"private"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PartnerAppResponse"}}},"description":"The requested partner app.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Partner app not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"OnboardingSessionBearer":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get partner app","tags":["partner_apps"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["developer.partner_apps.read","developer.partner_apps.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Updates the API version for a partner app owned by the authenticated merchant. Any supported version can be selected.","operationId":"updateDeveloperPartnerApp","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Flint partner app ID.","in":"path","name":"partner_app_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"api_version":"2026-09-07"},"schema":{"$ref":"#/components/schemas/UpdatePartnerAppRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"allowed_scopes":["commerce.bundles.read","commerce.bundles.write","commerce.catalog.read","commerce.orders.read","commerce.orders.write","commerce.products.read","customers.read","customers.write"],"api_version":"2026-09-07","app_type":"plugin","client_id":"fpc_1234567890abcdef1234567890abcd","created_at":"2026-03-18T20:00:00Z","default_requested_permissions":["manage_orders"],"name":"Acme Commerce Plugin","partner_app_id":"papp_01JQPARTNERAPP1234567890","permission_manifest":[{"description":"Read and update Flint orders for installed merchants.","permission_id":"manage_orders","required_scopes":["commerce.orders.read","commerce.orders.write"],"title":"Manage orders"},{"description":"Read and update customer records for installed merchants.","optional":true,"permission_id":"manage_customers","required_scopes":["customers.read","customers.write"],"title":"Manage customers"},{"description":"Read product, variant, bundle, and SKU lookup catalog records.","optional":true,"permission_id":"read_catalog","required_scopes":["commerce.products.read","commerce.bundles.read","commerce.catalog.read"],"title":"Read catalog"},{"description":"Create and update bundle catalog records for installed merchants.","optional":true,"permission_id":"manage_bundles","required_scopes":["commerce.bundles.write"],"title":"Manage bundles"}],"redirect_uris":["https://plugins.acme.com/flint/oauth/callback","http://localhost:3000/flint/oauth/callback"],"status":"active","updated_at":"2026-03-18T20:00:00Z","visibility":"private"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PartnerAppResponse"}}},"description":"The updated partner app.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Partner app not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"API_VERSION_CHANGED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API version changed. Reload the resource and review its current API version before trying again.","param":"expected_api_version","remediation":{"next_steps":"Reload the resource, review its current API version, and retry with that value as expected_api_version.","retryable":false},"type":"conflict_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The API version changed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"OnboardingSessionBearer":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update partner app","tags":["partner_apps"],"x-flint-error-codes":["API_VERSION_CHANGED","AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["developer.partner_apps.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/developer/partner/apps/{partner_app_id}/installs":{"get":{"description":"Returns installs for a partner app owned by the authenticated merchant.","operationId":"listDeveloperPartnerAppInstalls","parameters":[{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Flint partner app ID.","in":"path","name":"partner_app_id","required":true,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"created_at":"2026-03-18T20:05:00Z","environment_grants":[{"created_at":"2026-03-18T20:05:00Z","environment_grant_id":"egrt_01JQPARTNERGRANTTEST123456","environment_id":"test_01JQEXAMPLEDEFAULT12345678","granted_scopes":["commerce.orders.read","commerce.orders.write","commerce.products.read","commerce.bundles.read","commerce.catalog.read"],"mode":"test","status":"active","updated_at":"2026-03-18T20:05:00Z"},{"created_at":"2026-03-18T20:06:00Z","environment_grant_id":"egrt_01JQPARTNERGRANTLIVE123456","environment_id":"menv_01JQEXAMPLELIVE123456789","granted_scopes":["commerce.orders.read","commerce.orders.write","commerce.products.read","commerce.bundles.read","commerce.catalog.read"],"mode":"live","status":"active","updated_at":"2026-03-18T20:06:00Z"}],"granted_scopes":["commerce.orders.read","commerce.orders.write","commerce.products.read","commerce.bundles.read","commerce.catalog.read"],"installed_by_user_id":"usr_123","merchant_id":"mer_123","partner_app_install_id":"pinst_01JQPARTNERINSTALL123456","status":"active","updated_at":"2026-03-18T20:06:00Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PartnerAppInstallListResponse"}}},"description":"Partner app installs for the requested app.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Partner app not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"OnboardingSessionBearer":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List partner app installs","tags":["partner_apps"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["developer.partner_apps.read","developer.partner_apps.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/developer/partner/apps/{partner_app_id}/installs/{partner_app_install_id}":{"get":{"description":"Returns a single install for a partner app owned by the authenticated merchant.","operationId":"getDeveloperPartnerAppInstall","parameters":[{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Flint partner app ID.","in":"path","name":"partner_app_id","required":true,"schema":{"type":"string"}},{"description":"Flint partner app install ID.","in":"path","name":"partner_app_install_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-18T20:05:00Z","environment_grants":[{"created_at":"2026-03-18T20:05:00Z","environment_grant_id":"egrt_01JQPARTNERGRANTTEST123456","environment_id":"test_01JQEXAMPLEDEFAULT12345678","granted_scopes":["commerce.orders.read","commerce.orders.write","commerce.products.read","commerce.bundles.read","commerce.catalog.read"],"mode":"test","status":"active","updated_at":"2026-03-18T20:05:00Z"},{"created_at":"2026-03-18T20:06:00Z","environment_grant_id":"egrt_01JQPARTNERGRANTLIVE123456","environment_id":"menv_01JQEXAMPLELIVE123456789","granted_scopes":["commerce.orders.read","commerce.orders.write","commerce.products.read","commerce.bundles.read","commerce.catalog.read"],"mode":"live","status":"active","updated_at":"2026-03-18T20:06:00Z"}],"granted_scopes":["commerce.orders.read","commerce.orders.write","commerce.products.read","commerce.bundles.read","commerce.catalog.read"],"installed_by_user_id":"usr_123","merchant_id":"mer_123","partner_app_install_id":"pinst_01JQPARTNERINSTALL123456","status":"active","updated_at":"2026-03-18T20:06:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PartnerAppInstallResponse"}}},"description":"The requested partner app install.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Partner app or install not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"OnboardingSessionBearer":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get partner app install","tags":["partner_apps"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["developer.partner_apps.read","developer.partner_apps.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/developer/partner/apps/{partner_app_id}/installs/{partner_app_install_id}/environment-grants/{environment_grant_id}/revoke":{"post":{"description":"Revokes a single test or live environment grant for a partner app install.","operationId":"revokeDeveloperPartnerEnvironmentGrant","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Flint partner app ID.","in":"path","name":"partner_app_id","required":true,"schema":{"type":"string"}},{"description":"Flint partner app install ID.","in":"path","name":"partner_app_install_id","required":true,"schema":{"type":"string"}},{"description":"Flint environment grant ID.","in":"path","name":"environment_grant_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-18T20:05:00Z","environment_grants":[{"created_at":"2026-03-18T20:05:00Z","environment_grant_id":"egrt_01JQPARTNERGRANTTEST123456","environment_id":"test_01JQEXAMPLEDEFAULT12345678","granted_scopes":["commerce.orders.read","commerce.orders.write","commerce.products.read","commerce.bundles.read","commerce.catalog.read"],"mode":"test","status":"active","updated_at":"2026-03-18T20:05:00Z"},{"created_at":"2026-03-18T20:06:00Z","environment_grant_id":"egrt_01JQPARTNERGRANTLIVE123456","environment_id":"menv_01JQEXAMPLELIVE123456789","granted_scopes":["commerce.orders.read","commerce.orders.write","commerce.products.read","commerce.bundles.read","commerce.catalog.read"],"mode":"live","status":"active","updated_at":"2026-03-18T20:06:00Z"}],"granted_scopes":["commerce.orders.read","commerce.orders.write","commerce.products.read","commerce.bundles.read","commerce.catalog.read"],"installed_by_user_id":"usr_123","merchant_id":"mer_123","partner_app_install_id":"pinst_01JQPARTNERINSTALL123456","status":"active","updated_at":"2026-03-18T20:06:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PartnerAppInstallResponse"}}},"description":"The updated partner app install after the environment grant was revoked.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Partner app, install, or environment grant not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"OnboardingSessionBearer":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Revoke environment grant","tags":["partner_apps"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["developer.partner_apps.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/developer/partner/apps/{partner_app_id}/installs/{partner_app_install_id}/revoke":{"post":{"description":"Revokes a partner app install and all of its environment grants.","operationId":"revokeDeveloperPartnerAppInstall","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Flint partner app ID.","in":"path","name":"partner_app_id","required":true,"schema":{"type":"string"}},{"description":"Flint partner app install ID.","in":"path","name":"partner_app_install_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-18T20:05:00Z","environment_grants":[{"created_at":"2026-03-18T20:05:00Z","environment_grant_id":"egrt_01JQPARTNERGRANTTEST123456","environment_id":"test_01JQEXAMPLEDEFAULT12345678","granted_scopes":["commerce.orders.read","commerce.orders.write","commerce.products.read","commerce.bundles.read","commerce.catalog.read"],"mode":"test","status":"active","updated_at":"2026-03-18T20:05:00Z"},{"created_at":"2026-03-18T20:06:00Z","environment_grant_id":"egrt_01JQPARTNERGRANTLIVE123456","environment_id":"menv_01JQEXAMPLELIVE123456789","granted_scopes":["commerce.orders.read","commerce.orders.write","commerce.products.read","commerce.bundles.read","commerce.catalog.read"],"mode":"live","status":"active","updated_at":"2026-03-18T20:06:00Z"}],"granted_scopes":["commerce.orders.read","commerce.orders.write","commerce.products.read","commerce.bundles.read","commerce.catalog.read"],"installed_by_user_id":"usr_123","merchant_id":"mer_123","partner_app_install_id":"pinst_01JQPARTNERINSTALL123456","status":"active","updated_at":"2026-03-18T20:06:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PartnerAppInstallResponse"}}},"description":"The revoked partner app install.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Partner app or install not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"OnboardingSessionBearer":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Revoke partner app install","tags":["partner_apps"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["developer.partner_apps.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/developer/partner/apps/{partner_app_id}/rotate-secret":{"post":{"description":"Rotates the client secret for a partner app owned by the authenticated merchant. The new client_secret is only returned once.","operationId":"rotateDeveloperPartnerAppSecret","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Flint partner app ID.","in":"path","name":"partner_app_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"client_id":"fpc_1234567890abcdef1234567890abcd","client_secret":"fps_rotated1234567890abcdef1234567890abcdef1234567890abcdef12","partner_app_id":"papp_01JQPARTNERAPP1234567890"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/RotatePartnerAppSecretResponse"}}},"description":"The rotated client secret.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Partner app not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"OnboardingSessionBearer":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Rotate partner app secret","tags":["partner_apps"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["developer.partner_apps.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/developer/request-logs":{"get":{"description":"Returns request log summaries generated by the authenticated API key. Results are always scoped to the calling key. Full request and response bodies are intentionally omitted from this public API surface to reduce the risk of sensitive data leakage.","operationId":"listCurrentAPIKeyRequestLogs","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by Flint request ID.","in":"query","name":"request_id","required":false,"schema":{"type":"string"}},{"description":"Filter by HTTP method.","in":"query","name":"http_method","required":false,"schema":{"type":"string"}},{"description":"Filter by request path substring.","in":"query","name":"path_query","required":false,"schema":{"type":"string"}},{"description":"Filter by resource type.","in":"query","name":"resource_type","required":false,"schema":{"type":"string"}},{"description":"Filter by resource ID.","in":"query","name":"resource_id","required":false,"schema":{"type":"string"}},{"description":"Filter by response status bucket.","in":"query","name":"status_bucket","required":false,"schema":{"enum":["all","success","client_error","server_error"],"type":"string","x-enum-descriptions":["All.","Success.","Client error.","Server error."],"x-flint-enum":"closed"}},{"description":"RFC3339 lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"api_request_log_id":"rlog_123","correlation_id":"rlog_123","created_at":"2026-03-17T14:30:00Z","http_method":"GET","latency_milliseconds":12,"path":"/v1/orders/ord_123","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","resource_id":"ord_123","resource_type":"order","route_pattern":"GET /v1/orders/{order_id}","status_code":200}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/APIRequestLogListResponse"}}},"description":"A page of API request log summaries for the authenticated API key.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List API request logs for the current API key","tags":["api_keys"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["developer.request_logs.self.read"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"read"}},"/v1/developer/request-logs/{api_request_log_id}":{"get":{"description":"Returns redacted request log detail for a request generated by the authenticated API key. Detail responses remain current-key scoped and redact headers, query parameters, request bodies, and response bodies before returning them.","operationId":"getCurrentAPIKeyRequestLog","parameters":[{"description":"Flint API request log ID.","in":"path","name":"api_request_log_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"api_request_log_id":"rlog_123","correlation_id":"rlog_123","created_at":"2026-03-17T14:30:00Z","error_category":"validation","error_code":"VALIDATION_ERROR","error_summary":"The request payload or query parameters did not pass validation.","http_method":"POST","latency_milliseconds":42,"path":"/v1/payment-intents","query_params":null,"recommended_action":"Fix the field identified by the error response, then retry with the same idempotency key if this was the same logical operation.","reproduction":{"body":{"amount":2500,"currency":"USD","payment_source_token":"[REDACTED]"},"curl":"curl -X POST https://api.withflintpay.com/v1/payment-intents -H \"Authorization: Bearer \u003cAPI_KEY\u003e\" -H \"Idempotency-Key: \u003cNEW_IDEMPOTENCY_KEY\u003e\" --data '\u003cREDACTED_OR_CAPTURED_BODY\u003e'","headers":{"Authorization":"Bearer \u003cAPI_KEY\u003e","Idempotency-Key":"\u003cNEW_IDEMPOTENCY_KEY\u003e"},"http_method":"POST","path":"/v1/payment-intents","query_params":null,"recommended_environment":"test","redactions_present":true,"reproduction_complete":false,"safe_to_reproduce":false,"warnings":["This request may mutate live data; reproduce in test mode unless you have verified it is safe."]},"request_body":{"amount":2500,"currency":"USD","payment_source_token":"[REDACTED]"},"request_headers":{"content-type":"application/json"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","resource_id":"pi_123","resource_type":"payment_intent","response_body":{"error":{"code":"VALIDATION_ERROR","message":"payment_source_token is invalid."}},"response_content_type":"application/json","retryable":false,"route_pattern":"POST /v1/payment-intents","status_code":400},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/APIRequestLogDetailResponse"}}},"description":"Redacted API request log detail for the authenticated API key.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"api request log not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"API request log not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get API request log detail for the current API key","tags":["developer_logs"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["developer.request_logs.self.detail.read"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"read"}},"/v1/developer/resource-timelines/{resource_id}":{"get":{"description":"Returns summary-only API request, webhook event, and webhook delivery attempt entries for a single public API resource. The caller must have developer.resource_timelines.read and the matching read scope for the requested resource type.","operationId":"getResourceTimeline","parameters":[{"description":"Flint public API resource ID.","in":"path","name":"resource_id","required":true,"schema":{"type":"string"}},{"description":"Optional resource type. Must match the resource_id prefix when present.","in":"query","name":"resource_type","required":false,"schema":{"type":"string"}},{"description":"Optional comma-separated timeline entry groups. Defaults to requests,webhooks,attempts.","explode":false,"in":"query","name":"include","required":false,"schema":{"items":{"enum":["requests","webhooks","attempts"],"type":"string","x-enum-descriptions":["Requests.","Webhooks.","Attempts."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous timeline response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"RFC3339 lower bound for occurred_at.","in":"query","name":"occurred_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for occurred_at.","in":"query","name":"occurred_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"entries":[{"api_request_log_id":"rlog_123","correlation_id":"rlog_123","entry_type":"api_request","http_method":"POST","latency_milliseconds":42,"occurred_at":"2026-03-17T14:30:00Z","path":"/v1/payment-intents/pi_123/confirm","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","resource_id":"pi_123","resource_timeline_entry_id":"rlog_123","resource_type":"payment_intent","route_pattern":"POST /v1/payment-intents/{payment_intent_id}/confirm","status_code":200,"test":true},{"api_request_log_id":"rlog_123","automatic_attempt_count":1,"correlation_id":"rlog_123","entry_type":"webhook_event","event_source":"business_event","event_type":"payment_intent.succeeded","max_attempts":9,"occurred_at":"2026-03-17T14:30:01Z","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","resource_id":"pi_123","resource_timeline_entry_id":"whev_123","resource_type":"payment_intent","status":"delivered","test":true,"webhook_endpoint_id":"whep_123","webhook_event_id":"whev_123"},{"api_request_log_id":"rlog_123","attempt_number":1,"correlation_id":"rlog_123","delivery_trigger":"automatic_delivery","duration_milliseconds":98,"entry_type":"webhook_delivery_attempt","occurred_at":"2026-03-17T14:30:02Z","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","resource_id":"pi_123","resource_timeline_entry_id":"watt_123","resource_type":"payment_intent","status":"delivered","status_code":200,"test":true,"webhook_delivery_attempt_id":"watt_123","webhook_event_id":"whev_123"}],"resource_id":"pi_123","resource_type":"payment_intent","test":true},"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ResourceTimelineResponse"}}},"description":"A summary-only timeline for the requested resource.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get a resource timeline","tags":["developer_logs"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["developer.resource_timelines.read"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"read"}},"/v1/developer/sandboxes":{"get":{"description":"Returns the merchant's sandboxes, including archived sandboxes. Flint guarantees a default test sandbox for every merchant. Use an onboarding session token during setup or a normal external API key afterward.","operationId":"listDeveloperSandboxes","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Page token returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter sandboxes by status.","in":"query","name":"status","required":false,"schema":{"enum":["active","archived","all"],"type":"string","x-enum-descriptions":["Active.","Archived.","All."],"x-flint-enum":"open"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"created_at":"2026-03-18T19:45:00Z","is_default":true,"name":"Default Test","sandbox_id":"test_01JQEXAMPLEDEFAULT12345678","status":"active","updated_at":"2026-03-18T19:45:00Z"},{"created_at":"2026-03-18T20:00:00Z","is_default":false,"name":"Partner Demo","sandbox_id":"test_01JQEXAMPLEPARTNER1234567","status":"active","updated_at":"2026-03-18T20:00:00Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SandboxListResponse"}}},"description":"The merchant's sandboxes.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"OnboardingSessionBearer":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List sandboxes","tags":["sandboxes"],"x-flint-error-codes":["AUTH_REQUIRED","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["developer.sandboxes.read","developer.sandboxes.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates a new test sandbox for the current merchant. Optionally seeds the new empty sandbox with the merchant's live defaults and issues a sandbox-bound test key as part of creation.","operationId":"createDeveloperSandbox","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"issue_test_key":true,"name":"QA","scopes":["commerce.orders.read","commerce.orders.write"],"test_key_name":"QA integration key"},"schema":{"$ref":"#/components/schemas/CreateSandboxRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"api_key":{"api_key_id":"key_123","created_at":"2026-03-18T20:10:00Z","key_prefix":"flint_test_x7Yk","key_type":"external","name":"QA integration key","sandbox_id":"test_01JQEXAMPLEQASANDBOX123456","scopes":["commerce.orders.read","commerce.orders.write"],"status":"active","updated_at":"2026-03-18T20:10:00Z"},"created_at":"2026-03-18T20:10:00Z","is_default":false,"name":"QA","sandbox_id":"test_01JQEXAMPLEQASANDBOX123456","secret_key":"flint_test_51QAsampleSecret","status":"active","updated_at":"2026-03-18T20:10:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SandboxWithAPIKeyResponse"}}},"description":"The created sandbox, optionally with a newly issued test key.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"OnboardingSessionBearer":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create sandbox","tags":["sandboxes"],"x-flint-error-codes":["AUTH_REQUIRED","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["developer.sandboxes.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/developer/sandboxes/{sandbox_id}":{"delete":{"description":"Retires a non-default sandbox and frees its original name for reuse.","operationId":"deleteDeveloperSandbox","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Flint sandbox ID.","in":"path","name":"sandbox_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-18T19:45:00Z","is_default":true,"name":"Default Test","sandbox_id":"test_01JQEXAMPLEDEFAULT12345678","status":"active","updated_at":"2026-03-18T19:45:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SandboxResponse"}}},"description":"The retired sandbox.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Sandbox not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"OnboardingSessionBearer":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Retire sandbox","tags":["sandboxes"],"x-flint-error-codes":["AUTH_REQUIRED","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["developer.sandboxes.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"},"get":{"description":"Returns a single sandbox by ID.","operationId":"getDeveloperSandbox","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Flint sandbox ID.","in":"path","name":"sandbox_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-18T19:45:00Z","is_default":true,"name":"Default Test","sandbox_id":"test_01JQEXAMPLEDEFAULT12345678","status":"active","updated_at":"2026-03-18T19:45:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SandboxResponse"}}},"description":"The requested sandbox.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Sandbox not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"OnboardingSessionBearer":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get sandbox","tags":["sandboxes"],"x-flint-error-codes":["AUTH_REQUIRED","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["developer.sandboxes.read","developer.sandboxes.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/developer/sandboxes/{sandbox_id}/reset":{"post":{"description":"Clears a non-default sandbox and returns its replacement environment. The replacement has a new sandbox ID, retains the stable provider-account lineage, and requires newly issued test keys.","operationId":"resetDeveloperSandbox","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Flint sandbox ID.","in":"path","name":"sandbox_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-18T19:45:00Z","is_default":true,"name":"Default Test","sandbox_id":"test_01JQEXAMPLEDEFAULT12345678","status":"active","updated_at":"2026-03-18T19:45:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SandboxResponse"}}},"description":"The reset sandbox.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Sandbox not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"OnboardingSessionBearer":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Reset sandbox","tags":["sandboxes"],"x-flint-error-codes":["AUTH_REQUIRED","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["developer.sandboxes.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/developer/sandboxes/{sandbox_id}/test-key":{"post":{"description":"Creates a new test API key that is bound to the target sandbox.","operationId":"issueDeveloperSandboxTestKey","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Flint sandbox ID.","in":"path","name":"sandbox_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"name":"Partner demo key","scopes":["commerce.orders.read","customers.read"]},"schema":{"$ref":"#/components/schemas/IssueSandboxAPIKeyRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"api_key_id":"key_123","created_at":"2026-03-17T14:30:00Z","expires_at":"2027-03-17T14:30:00Z","key_prefix":"flint_test_abcd1234","key_type":"external","last_used_at":"2026-03-17T15:00:00Z","merchant_id":"mer_123","name":"Sandbox orders integration","sandbox_id":"test_01JQEXAMPLEDEFAULT12345678","scopes":["accounts.api_keys.read","accounts.api_keys.write","commerce.orders.read","commerce.orders.write"],"secret_key":"flint_test_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef","status":"active","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CreateAPIKeyResponse"}}},"description":"The created sandbox-bound test key. secret_key is only returned once.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Sandbox not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"OnboardingSessionBearer":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Issue sandbox test key","tags":["sandboxes"],"x-flint-error-codes":["AUTH_REQUIRED","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["accounts.api_keys.write","developer.sandboxes.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/devices":{"get":{"description":"Returns a paginated list of devices for the authenticated merchant.","operationId":"listDevices","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by device status.","in":"query","name":"status","required":false,"schema":{"enum":["active","deleted"],"type":"string","x-enum-descriptions":["Active.","Deleted."],"x-flint-enum":"open"}},{"description":"Filter by assigned Flint location ID.","in":"query","name":"location_id","required":false,"schema":{"type":"string"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["name","created_at","updated_at"],"type":"string","x-enum-descriptions":["Name.","Created at.","Updated at."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"created_at":"2026-03-17T14:30:00Z","device_id":"dev_123","hardware_fingerprint":"ios-device-uuid-123","location_id":"loc_123","merchant_id":"mer_123","metadata":{"register":"front_counter"},"name":"Front Counter iPad","status":"active","updated_at":"2026-03-17T14:30:00Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/DeviceListResponse"}}},"description":"A page of devices.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List devices","tags":["devices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["accounts.devices.read","accounts.devices.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates a device for the authenticated merchant. If hardware_fingerprint matches an existing device, the existing device is returned with 200 OK and data.already_existed=true.","operationId":"createDevice","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"hardware_fingerprint":"ios-device-uuid-123","location_id":"loc_123","metadata":{"register":"front_counter"},"name":"Front Counter iPad"},"schema":{"$ref":"#/components/schemas/CreateDeviceRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"already_existed":true,"created_at":"2026-03-17T14:30:00Z","device_id":"dev_123","hardware_fingerprint":"ios-device-uuid-123","location_id":"loc_123","merchant_id":"mer_123","metadata":{"register":"front_counter"},"name":"Front Counter iPad","status":"active","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CreateDeviceResponse"}}},"description":"An existing device matched the supplied hardware fingerprint.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"201":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-17T14:30:00Z","device_id":"dev_123","hardware_fingerprint":"ios-device-uuid-123","location_id":"loc_123","merchant_id":"mer_123","metadata":{"register":"front_counter"},"name":"Front Counter iPad","status":"active","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CreateDeviceResponse"}}},"description":"The created device.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create device","tags":["devices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["accounts.devices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/devices/{device_id}":{"delete":{"description":"Marks a device as deleted and returns its final state.","operationId":"deleteDevice","parameters":[{"description":"Flint device ID.","in":"path","name":"device_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-17T14:30:00Z","device_id":"dev_123","hardware_fingerprint":"ios-device-uuid-123","location_id":"loc_123","merchant_id":"mer_123","metadata":{"register":"front_counter"},"name":"Front Counter iPad","status":"active","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/DeviceResponse"}}},"description":"The deleted device.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"device not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Device not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Delete device","tags":["devices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["accounts.devices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Returns a single device by ID.","operationId":"getDevice","parameters":[{"description":"Flint device ID.","in":"path","name":"device_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-17T14:30:00Z","device_id":"dev_123","hardware_fingerprint":"ios-device-uuid-123","location_id":"loc_123","merchant_id":"mer_123","metadata":{"register":"front_counter"},"name":"Front Counter iPad","status":"active","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/DeviceResponse"}}},"description":"The requested device.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"device not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Device not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get device","tags":["devices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["accounts.devices.read","accounts.devices.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Applies a sparse update to a device. Send location_id=null to unassign a location.","operationId":"updateDevice","parameters":[{"description":"Flint device ID.","in":"path","name":"device_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"metadata":{"floor":"1","register":"front_counter"},"name":"Front Counter iPad 2"},"schema":{"$ref":"#/components/schemas/UpdateDeviceRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-17T14:30:00Z","device_id":"dev_123","hardware_fingerprint":"ios-device-uuid-123","location_id":"loc_123","merchant_id":"mer_123","metadata":{"register":"front_counter"},"name":"Front Counter iPad","status":"active","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/DeviceResponse"}}},"description":"The updated device.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"device not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Device not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update device","tags":["devices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["accounts.devices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/disputes":{"get":{"description":"Returns a paginated list of disputes for the authenticated merchant with optional payment, customer, status, reason, case type, and timing filters.","operationId":"listDisputes","parameters":[{"description":"Optional Flint payment intent ID filter.","in":"query","name":"payment_intent_id","required":false,"schema":{"type":"string"}},{"description":"Optional Flint order ID filter.","in":"query","name":"order_id","required":false,"schema":{"type":"string"}},{"description":"Optional Flint customer ID filter.","in":"query","name":"customer_id","required":false,"schema":{"type":"string"}},{"description":"Optional dispute status filter.","in":"query","name":"status","required":false,"schema":{"enum":["warning_needs_response","warning_under_review","warning_closed","needs_response","under_review","won","lost","prevented"],"type":"string","x-enum-descriptions":["Warning needs response.","Warning under review.","Warning closed.","Needs response.","Under review.","Won.","Lost.","Prevented."],"x-flint-enum":"open"}},{"description":"Optional normalized dispute reason filter.","in":"query","name":"reason","required":false,"schema":{"enum":["bank_cannot_process","check_returned","credit_not_processed","customer_initiated","debit_not_authorized","duplicate","fraudulent","general","incorrect_account_details","insufficient_funds","noncompliant","product_not_received","product_unacceptable","subscription_canceled","unrecognized","bank_account_closed","bank_account_not_found","bank_debit_not_authorized","bank_account_restricted","other"],"type":"string","x-enum-descriptions":["Bank cannot process.","Check returned.","Credit not processed.","Customer initiated.","Debit not authorized.","Duplicate.","Fraudulent.","General.","Incorrect account details.","Insufficient funds.","Noncompliant.","Product not received.","Product unacceptable.","Subscription canceled.","Unrecognized.","Bank account closed.","Bank account not found.","Bank debit not authorized.","Bank account restricted.","Other."],"x-flint-enum":"closed"}},{"description":"Optional dispute case type filter.","in":"query","name":"case_type","required":false,"schema":{"enum":["inquiry","chargeback","compliance","resolution","block","other","bank_return"],"type":"string","x-enum-descriptions":["Inquiry.","Chargeback.","Compliance.","Resolution.","Block.","Other.","Bank return."],"x-flint-enum":"closed"}},{"description":"Only include disputes created at or after this RFC3339 timestamp.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Only include disputes created at or before this RFC3339 timestamp.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Only include disputes with evidence due at or after this RFC3339 timestamp.","in":"query","name":"evidence_due_after","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Only include disputes with evidence due at or before this RFC3339 timestamp.","in":"query","name":"evidence_due_before","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Page token returned by the previous response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisputeListResponse"}}},"description":"A page of disputes for the authenticated merchant.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List disputes","tags":["disputes"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["payments.disputes.read"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"read"}},"/v1/disputes/{dispute_id}":{"get":{"description":"Returns one dispute by ID, with optional customer, order, and payment intent expansions.","operationId":"getDispute","parameters":[{"description":"Flint dispute ID.","in":"path","name":"dispute_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: customer, order, payment_intent. Expansion requires payments.disputes.read plus the read scope for each expanded resource. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=customer\u0026expand=order, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["customer","order","payment_intent"],"type":"string","x-enum-descriptions":["Customer.","Order.","Payment intent."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Dispute","value":{"data":{"action_required":true,"amount_money":{"amount":5000,"currency":"USD"},"case_type":"chargeback","created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","dispute_id":"du_123","evidence_deadline_passed":false,"evidence_due_at":"2026-03-24T14:30:00Z","evidence_response_allowed":true,"evidence_submission_count":0,"evidence_submission_past_due":false,"merchant_id":"mer_123","metadata":{"case":"chargeback"},"order_id":"ord_123","payment_intent_id":"pi_123","payment_option":"card","reason":"fraudulent","status":"needs_response","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Dispute with expanded relationships","value":{"data":{"action_required":true,"amount_money":{"amount":5000,"currency":"USD"},"case_type":"chargeback","created_at":"2026-03-17T14:30:00Z","customer":{"created_at":"2026-03-16T12:00:00Z","customer_id":"cus_123","email":"buyer@example.com","name":"Avery Buyer","updated_at":"2026-03-17T14:00:00Z"},"customer_id":"cus_123","dispute_id":"du_123","evidence_deadline_passed":false,"evidence_due_at":"2026-03-24T14:30:00Z","evidence_response_allowed":true,"evidence_submission_count":0,"evidence_submission_past_due":false,"merchant_id":"mer_123","metadata":{"case":"chargeback"},"order":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","fulfillment_status":"not_fulfilled","order_id":"ord_123","order_number":"1001","payment_intent_ids":["pi_123"],"payment_status":"","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":0,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":5000,"currency":"USD"},"outstanding_money":{"amount":0,"currency":"USD"},"paid_money":{"amount":5000,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"paid","updated_at":"2026-03-17T14:30:00Z"},"order_id":"ord_123","payment_intent":{"amount_money":{"amount":5000,"currency":"USD"},"capture_method":"automatic","created_at":"2026-03-17T14:20:00Z","customer_id":"cus_123","order_id":"ord_123","payment_intent_id":"pi_123","payment_source":{"card":{"brand":"visa","last4":"4242"},"type":"card"},"refund_status":"none","status":"succeeded","updated_at":"2026-03-17T14:30:00Z"},"payment_intent_id":"pi_123","payment_option":"card","reason":"fraudulent","status":"needs_response","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/DisputeResponse"}}},"description":"The requested dispute.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Dispute not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get a dispute","tags":["disputes"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["payments.disputes.read"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"read"}},"/v1/feedback-reports":{"get":{"description":"Lists feedback reports in descending creation order for the credential's merchant and environment.","operationId":"listFeedbackReports","parameters":[{"description":"Number of reports to return.","in":"query","name":"page_size","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque token returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackReportListResponse"}}},"description":"Feedback reports for the authenticated merchant and environment.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The credential does not have the feedback read scope.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Feedback reports are temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List feedback reports","tags":["feedback_reports"],"x-flint-error-codes":["AUTH_REQUIRED","FEEDBACK_REPORTS_UNAVAILABLE","INSUFFICIENT_SCOPE","INVALID_PAGE_SIZE","INVALID_PAGE_TOKEN","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["developer.feedback_reports.read"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"read"},"post":{"description":"Stores one immutable occurrence of Flint feedback. Use one report per root cause and include only the evidence needed to describe Flint's behavior.","operationId":"createFeedbackReport","parameters":[{"description":"Optional idempotency key for safe retries. Flint generates and returns one when omitted. Do not include personal information or secrets.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedbackReportRequest"}}},"description":"Maximum raw JSON body size is 512 KiB.","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackReportResponse"}}},"description":"The stored feedback report.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid or unsafe feedback.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The credential does not have the feedback write scope.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Idempotency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Feedback reports are temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create a feedback report","tags":["feedback_reports"],"x-flint-error-codes":["AUTH_REQUIRED","FEEDBACK_REPORTS_UNAVAILABLE","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_FEEDBACK_KIND","INVALID_FEEDBACK_SHAPE","INVALID_FEEDBACK_SURFACE","INVALID_IDEMPOTENCY_KEY","INVALID_RELATED_REQUEST_ID","INVALID_RELATED_RESOURCE_ID","INVALID_REQUEST","INVALID_SURFACE_ROUTE","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE","UNSAFE_FEEDBACK_CONTENT"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["developer.feedback_reports.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/feedback-reports/{feedback_report_id}":{"get":{"description":"Returns one immutable feedback report in the credential's merchant and environment.","operationId":"getFeedbackReport","parameters":[{"description":"Flint feedback report ID.","in":"path","name":"feedback_report_id","required":true,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackReportResponse"}}},"description":"The requested feedback report.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The credential does not have the feedback read scope.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Feedback report not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Feedback reports are temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get a feedback report","tags":["feedback_reports"],"x-flint-error-codes":["AUTH_REQUIRED","FEEDBACK_REPORTS_UNAVAILABLE","FEEDBACK_REPORT_NOT_FOUND","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["developer.feedback_reports.read"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"read"}},"/v1/fraud-warnings":{"get":{"description":"List early fraud warnings for the authenticated merchant environment.","operationId":"listFraudWarnings","parameters":[{"description":"Filter by whether a proactive fraudulent refund can still prevent a dispute.","in":"query","name":"actionable","required":false,"schema":{"type":"boolean"}},{"description":"Filter by Flint payment intent ID.","in":"query","name":"payment_intent_id","required":false,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FraudWarningListResponse"}}},"description":"List early fraud warnings result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List early fraud warnings","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.controls.write","risk.read","risk.reviews.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/fraud-warnings/{fraud_warning_id}":{"get":{"description":"Get an early fraud warning for the authenticated merchant environment.","operationId":"getFraudWarning","parameters":[{"description":"Flint fraud warning ID.","in":"path","name":"fraud_warning_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: dispute, payment_intent. Expansion requires risk.read plus the read scope for each expanded resource. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=dispute\u0026expand=payment_intent, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["dispute","payment_intent"],"type":"string","x-enum-descriptions":["Dispute.","Payment intent."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Fraud warning","value":{"data":{"actionable":true,"created_at":"2026-07-09T18:02:12Z","dispute_id":null,"fraud_type":"unauthorized_use_of_card","fraud_warning_id":"fw_123","payment_intent_id":"pi_123","payment_summary":{"amount_money":{"amount":12900,"currency":"USD"},"email":"buyer@example.com","last4":"4242","payment_method_brand":"visa"},"reported_at":"2026-07-09T18:02:11Z"},"request_id":"req_123"}},"expanded":{"summary":"Fraud warning with expanded relationships","value":{"data":{"actionable":true,"created_at":"2026-07-09T18:02:12Z","dispute":{"action_required":false,"amount_money":{"amount":12900,"currency":"USD"},"case_type":"chargeback","created_at":"2026-07-10T18:02:11Z","dispute_id":"du_123","evidence_deadline_passed":false,"evidence_due_at":null,"evidence_response_allowed":false,"evidence_submission_count":0,"evidence_submission_past_due":false,"fraud_warning_id":"fw_123","merchant_id":"mer_123","metadata":{},"payment_intent_id":"pi_123","payment_option":null,"reason":"fraudulent","status":"needs_response","updated_at":"2026-07-10T18:02:11Z"},"dispute_id":"du_123","fraud_type":"unauthorized_use_of_card","fraud_warning_id":"fw_123","payment_intent":{"amount_money":{"amount":12900,"currency":"USD"},"payment_intent_id":"pi_123","status":"succeeded"},"payment_intent_id":"pi_123","payment_summary":{"amount_money":{"amount":12900,"currency":"USD"},"email":"buyer@example.com","last4":"4242","payment_method_brand":"visa"},"reported_at":"2026-07-09T18:02:11Z"},"request_id":"req_123"}}},"schema":{"$ref":"#/components/schemas/FraudWarningResponse"}}},"description":"The requested early fraud warning.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get an early fraud warning","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.controls.write","risk.read","risk.reviews.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/fulfillment-events":{"get":{"description":"Lists provider-neutral fulfillment events. Results default to newest received first.","operationId":"listFulfillmentEvents","parameters":[{"description":"Optional fulfillment ID filter.","in":"query","name":"fulfillment_id","required":false,"schema":{"type":"string"}},{"description":"Optional shipment ID filter.","in":"query","name":"shipment_id","required":false,"schema":{"type":"string"}},{"description":"Optional package ID filter.","in":"query","name":"package_id","required":false,"schema":{"type":"string"}},{"description":"Optional order ID filter.","in":"query","name":"order_id","required":false,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by fulfillment event type.","in":"query","name":"event_type","required":false,"schema":{"enum":["accepted","preparing","picked","packed","ready","shipped","dispatched","in_transit","out_for_delivery","delivered","delivery_attempted","tracking_updated","exception","returned","completed","canceled","failed","no_show","custom"],"type":"string","x-enum-descriptions":["Accepted.","Preparing.","Picked.","Packed.","Ready.","Shipped.","Dispatched.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Tracking updated.","Exception.","Returned.","Completed.","Canceled.","Failed.","No show.","Custom."],"x-flint-enum":"closed"}},{"description":"Filter by external system identifier.","in":"query","name":"external_system","required":false,"schema":{"type":"string"}},{"description":"Filter by external provider event ID.","in":"query","name":"external_event_id","required":false,"schema":{"type":"string"}},{"description":"RFC3339 lower bound for occurred_at.","in":"query","name":"occurred_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for occurred_at.","in":"query","name":"occurred_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Sort field. Defaults to received_at.","in":"query","name":"sort_by","required":false,"schema":{"enum":["received_at","occurred_at"],"type":"string","x-enum-descriptions":["Received at.","Occurred at."],"x-flint-enum":"closed"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"buyer_notification_behavior":"request","custom_details":{"provider_carrier":"ups"},"event_type":"tracking_updated","external_event_id":"evt_7f3df2","external_status":"delivered","external_system":"shippo","fulfillment_event_id":"fev_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","message":"Carrier marked the package delivered.","occurred_at":"2026-05-13T14:30:00Z","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","received_at":"2026-05-13T14:30:01Z","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","subject_type":""}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/FulfillmentEventListResponse"}}},"description":"Fulfillment events for the fulfillment.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List fulfillment events","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.read","commerce.orders.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/fulfillment-events/{fulfillment_event_id}":{"get":{"description":"Retrieves one provider-neutral fulfillment event by ID.","operationId":"getFulfillmentEvent","parameters":[{"description":"Flint fulfillment event ID.","in":"path","name":"fulfillment_event_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: order. Expansion requires commerce.orders.read. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=order\u0026expand=order, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["order"],"type":"string","x-enum-descriptions":["Order."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Fulfillment event","value":{"data":{"buyer_notification_behavior":"request","custom_details":{"provider_carrier":"ups"},"event_type":"tracking_updated","external_event_id":"evt_7f3df2","external_status":"delivered","external_system":"shippo","fulfillment_event_id":"fev_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","message":"Carrier marked the package delivered.","occurred_at":"2026-05-13T14:30:00Z","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","received_at":"2026-05-13T14:30:01Z","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","subject_type":""},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Fulfillment event with expanded order","value":{"data":{"buyer_notification_behavior":"request","custom_details":{"provider_carrier":"ups"},"event_type":"tracking_updated","external_event_id":"evt_7f3df2","external_status":"delivered","external_system":"shippo","fulfillment_event_id":"fev_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","message":"Carrier marked the package delivered.","occurred_at":"2026-05-13T14:30:00Z","order":{"created_at":"2026-05-13T09:30:00Z","customer_id":"cus_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_status":"completed","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","order_number":"1001","payment_intent_ids":["pi_01ABCDEFGHIJKLMNOPQRSTUVWX"],"payment_status":"","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","updated_at":"2026-05-13T14:30:00Z"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","received_at":"2026-05-13T14:30:01Z","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","subject_type":""},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/FulfillmentEventResourceResponse"}}},"description":"The fulfillment event.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order, fulfillment, or event not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get fulfillment event","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.read","commerce.orders.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/fulfillment-notifications":{"get":{"description":"Returns persisted fulfillment notification audit records. Results default to newest created first.","operationId":"listFulfillmentNotifications","parameters":[{"description":"Optional fulfillment ID filter.","in":"query","name":"fulfillment_id","required":false,"schema":{"type":"string"}},{"description":"Optional order ID filter.","in":"query","name":"order_id","required":false,"schema":{"type":"string"}},{"description":"Optional fulfillment event ID filter.","in":"query","name":"fulfillment_event_id","required":false,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by notification channel.","in":"query","name":"channel","required":false,"schema":{"enum":["email"],"type":"string","x-enum-descriptions":["Email."],"x-flint-enum":"closed"}},{"description":"Filter by notification status.","in":"query","name":"status","required":false,"schema":{"enum":["pending","sent","failed","suppressed"],"type":"string","x-enum-descriptions":["Pending.","Sent.","Failed.","Suppressed."],"x-flint-enum":"open"}},{"description":"Filter by notification type.","in":"query","name":"notification_type","required":false,"schema":{"enum":["fulfillment_canceled","fulfillment_completed","fulfillment_delivered","fulfillment_delivery_attempted","fulfillment_dispatched","fulfillment_exception","fulfillment_failed","fulfillment_in_transit","fulfillment_no_show","fulfillment_out_for_delivery","fulfillment_ready","fulfillment_returned","fulfillment_shipped","shipment_delivered","shipment_delivery_attempted","shipment_exception","shipment_in_transit","shipment_out_for_delivery","shipment_returned","shipment_shipped","tracking_updated"],"type":"string","x-enum-descriptions":["Fulfillment canceled.","Fulfillment completed.","Fulfillment delivered.","Fulfillment delivery attempted.","Fulfillment dispatched.","Fulfillment exception.","Fulfillment failed.","Fulfillment in transit.","Fulfillment no show.","Fulfillment out for delivery.","Fulfillment ready.","Fulfillment returned.","Fulfillment shipped.","Shipment delivered.","Shipment delivery attempted.","Shipment exception.","Shipment in transit.","Shipment out for delivery.","Shipment returned.","Shipment shipped.","Tracking updated."],"x-flint-enum":"closed"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"channel":"email","created_at":"2026-05-13T14:30:01Z","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_notification_id":"fnt_01ABCDEFGHIJKLMNOPQRSTUVWX","notification_type":"fulfillment_completed","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","recipient_email":"buyer@example.com","sent_at":"2026-05-13T14:30:02Z","status":"sent","trigger_type":"status_update","updated_at":"2026-05-13T14:30:02Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/FulfillmentNotificationListResponse"}}},"description":"Fulfillment notifications for the fulfillment.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List fulfillment notifications","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.read","commerce.orders.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/fulfillment-notifications/{fulfillment_notification_id}":{"get":{"description":"Retrieves one fulfillment notification audit record by ID.","operationId":"getFulfillmentNotification","parameters":[{"description":"Flint fulfillment notification ID.","in":"path","name":"fulfillment_notification_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: order. Expansion requires commerce.orders.read. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=order\u0026expand=order, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["order"],"type":"string","x-enum-descriptions":["Order."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Fulfillment notification","value":{"data":{"channel":"email","created_at":"2026-05-13T14:30:01Z","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_notification_id":"fnt_01ABCDEFGHIJKLMNOPQRSTUVWX","notification_type":"fulfillment_completed","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","recipient_email":"buyer@example.com","sent_at":"2026-05-13T14:30:02Z","status":"sent","trigger_type":"status_update","updated_at":"2026-05-13T14:30:02Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Fulfillment notification with expanded order","value":{"data":{"channel":"email","created_at":"2026-05-13T14:30:01Z","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_notification_id":"fnt_01ABCDEFGHIJKLMNOPQRSTUVWX","notification_type":"fulfillment_completed","order":{"created_at":"2026-05-13T09:30:00Z","customer_id":"cus_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_status":"completed","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","order_number":"1001","payment_intent_ids":["pi_01ABCDEFGHIJKLMNOPQRSTUVWX"],"payment_status":"","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","updated_at":"2026-05-13T14:30:00Z"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","recipient_email":"buyer@example.com","sent_at":"2026-05-13T14:30:02Z","status":"sent","trigger_type":"status_update","updated_at":"2026-05-13T14:30:02Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/FulfillmentNotificationResponse"}}},"description":"The fulfillment notification.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Fulfillment notification not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get fulfillment notification","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.read","commerce.orders.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/fulfillments":{"get":{"description":"Returns fulfillments for operational queue and order-detail views. Results default to newest created first.","operationId":"listFulfillments","parameters":[{"description":"Supported expansions: order. Expansion requires commerce.orders.read. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=order\u0026expand=order, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["order"],"type":"string","x-enum-descriptions":["Order."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Filter by order ID.","in":"query","name":"order_id","required":false,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search across fulfillment_id and external_reference_id. Also matches an exact order number.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Filter by the projected value returned in Fulfillment.status. Fulfillments with request_status accepted project to status pending. Fulfillments with outcome.outcome_type no_show project to status failed. A fulfillment with active_hold projects to its public work status from before the hold.","in":"query","name":"status","required":false,"schema":{"enum":["pending","in_progress","ready","completed","canceled","failed","scheduled","preparing","picked","packed","dispatched"],"type":"string","x-enum-descriptions":["Pending.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Preparing.","Picked.","Packed.","Dispatched."],"x-flint-enum":"open"}},{"description":"Filter by fulfillment type.","in":"query","name":"type","required":false,"schema":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"}},{"description":"Filter by assigned Location ID.","in":"query","name":"location_id","required":false,"schema":{"type":"string"}},{"description":"Lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Lower bound for updated_at.","in":"query","name":"updated_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Upper bound for updated_at.","in":"query","name":"updated_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Sort direction for created_at. Defaults to desc.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Fulfillment list","value":{"data":[{"completed_at":"2026-05-13T14:30:00Z","created_at":"2026-05-13T09:45:00Z","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","line_items":[{"order_line_item_id":"li_123","quantity":1}],"metadata":{"source":"dispatch"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","request_status":"accepted","status":"completed","supported_actions":[],"type":"shipment","updated_at":"2026-05-13T14:30:00Z","version":4}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Fulfillment list with expanded orders","value":{"data":[{"completed_at":"2026-05-13T14:30:00Z","created_at":"2026-05-13T09:45:00Z","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","line_items":[{"order_line_item_id":"li_123","quantity":1}],"metadata":{"source":"dispatch"},"order":{"created_at":"2026-05-13T09:30:00Z","customer_id":"cus_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_status":"completed","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","order_number":"1001","payment_intent_ids":["pi_01ABCDEFGHIJKLMNOPQRSTUVWX"],"payment_status":"","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","updated_at":"2026-05-13T14:30:00Z"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","packages":[{"carrier":"ups","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"in_transit","supported_actions":null,"tracking_number":"1Z999AA10123456784","tracking_url":"https://track.example.com/1Z999AA10123456784","version":0}],"request_status":"accepted","shipments":[{"direction":"outbound","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","package_count":0,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"in_transit"}],"status":"completed","supported_actions":[],"type":"shipment","updated_at":"2026-05-13T14:30:00Z","version":4}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/FulfillmentListResponse"}}},"description":"Fulfillments for the order.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List fulfillments","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.read","commerce.orders.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/fulfillments/{fulfillment_id}":{"get":{"description":"Retrieves a single fulfillment by ID.","operationId":"getFulfillment","parameters":[{"description":"Flint fulfillment ID.","in":"path","name":"fulfillment_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: order, packages, shipments. Expansion requires commerce.orders.read. Limits: at most 10 unique expand paths per request; path depth at most 2. To-many expansions are capped at 20 related objects per path. Repeat expand, for example expand=order\u0026expand=packages, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["order","packages","shipments"],"type":"string","x-enum-descriptions":["Order.","Packages.","Shipments."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Fulfillment","value":{"data":{"completed_at":"2026-05-13T14:30:00Z","created_at":"2026-05-13T09:45:00Z","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","line_items":[{"order_line_item_id":"li_123","quantity":1}],"metadata":{"source":"dispatch"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","request_status":"accepted","status":"completed","supported_actions":[],"type":"shipment","updated_at":"2026-05-13T14:30:00Z","version":4},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Fulfillment with expanded order","value":{"data":{"completed_at":"2026-05-13T14:30:00Z","created_at":"2026-05-13T09:45:00Z","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","line_items":[{"order_line_item_id":"li_123","quantity":1}],"metadata":{"source":"dispatch"},"order":{"created_at":"2026-05-13T09:30:00Z","customer_id":"cus_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_status":"completed","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","order_number":"1001","payment_intent_ids":["pi_01ABCDEFGHIJKLMNOPQRSTUVWX"],"payment_status":"","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","updated_at":"2026-05-13T14:30:00Z"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","packages":[{"carrier":"ups","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"in_transit","supported_actions":null,"tracking_number":"1Z999AA10123456784","tracking_url":"https://track.example.com/1Z999AA10123456784","version":0}],"request_status":"accepted","shipments":[{"direction":"outbound","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","package_count":0,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"in_transit"}],"status":"completed","supported_actions":[],"type":"shipment","updated_at":"2026-05-13T14:30:00Z","version":4},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/FulfillmentResponse"}}},"description":"The requested fulfillment.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Fulfillment not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get fulfillment","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.read","commerce.orders.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Updates mutable fulfillment fields and fulfillment-specific details. Fulfillment line item allocation is set when the fulfillment is created. expected_version is optional and rejects a stale resource version when supplied.","operationId":"updateFulfillment","parameters":[{"description":"Flint fulfillment ID.","in":"path","name":"fulfillment_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"expected_version":3,"location_id":"loc_123","metadata":{"stage":"ready"}},"schema":{"$ref":"#/components/schemas/UpdateFulfillmentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"The updated order.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order or fulfillment not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"FULFILLMENT_CHANGED","details":[{"code":"FULFILLMENT_CHANGED","current_resource":{"completed_at":"2026-05-13T14:30:00Z","created_at":"2026-05-13T09:45:00Z","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","line_items":[{"order_line_item_id":"li_123","quantity":1}],"metadata":{"source":"dispatch"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","request_status":"accepted","status":"completed","supported_actions":[],"type":"shipment","updated_at":"2026-05-13T14:30:00Z","version":4},"current_status":"completed","current_version":4,"message":"the fulfillment changed","param":"expected_version","remediation":{"next_steps":"Read the current fulfillment and retry with its version as expected_version.","retryable":true}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"expected_version does not match the current fulfillment version; read the fulfillment and retry","param":"expected_version","remediation":{"next_steps":"Read the current fulfillment and retry with its version as expected_version.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update fulfillment","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_CHANGED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_EXPECTED_VERSION","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/fulfillments/{fulfillment_id}/events":{"post":{"description":"Records an observational event for a fulfillment or one of its shipments or packages.","operationId":"createFulfillmentEvent","parameters":[{"description":"Flint fulfillment ID.","in":"path","name":"fulfillment_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"buyer_notification_behavior":"send","custom_details":{"facility":"east"},"event_type":"custom","external_event_id":"evt_7f3df2","external_status":"work_started","external_system":"shippo","message":"The fulfillment partner started work.","occurred_at":"2026-05-13T14:30:00Z","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX"},"schema":{"$ref":"#/components/schemas/CreateFulfillmentEventRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"fulfillment":{"completed_at":"2026-05-13T14:30:00Z","created_at":"2026-05-13T09:45:00Z","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","line_items":[{"order_line_item_id":"li_123","quantity":1}],"metadata":{"source":"dispatch"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","request_status":"accepted","status":"completed","supported_actions":[],"type":"shipment","updated_at":"2026-05-13T14:30:00Z","version":4},"fulfillment_event":{"buyer_notification_behavior":"request","custom_details":{"provider_carrier":"ups"},"event_type":"tracking_updated","external_event_id":"evt_7f3df2","external_status":"delivered","external_system":"shippo","fulfillment_event_id":"fev_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","message":"Carrier marked the package delivered.","occurred_at":"2026-05-13T14:30:00Z","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","received_at":"2026-05-13T14:30:01Z","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","subject_type":""},"replayed":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/FulfillmentEventResponse"}}},"description":"The replayed fulfillment event for an existing provider event.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"201":{"content":{"application/json":{"example":{"data":{"fulfillment":{"completed_at":"2026-05-13T14:30:00Z","created_at":"2026-05-13T09:45:00Z","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","line_items":[{"order_line_item_id":"li_123","quantity":1}],"metadata":{"source":"dispatch"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","request_status":"accepted","status":"completed","supported_actions":[],"type":"shipment","updated_at":"2026-05-13T14:30:00Z","version":4},"fulfillment_event":{"buyer_notification_behavior":"request","custom_details":{"provider_carrier":"ups"},"event_type":"tracking_updated","external_event_id":"evt_7f3df2","external_status":"delivered","external_system":"shippo","fulfillment_event_id":"fev_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","message":"Carrier marked the package delivered.","occurred_at":"2026-05-13T14:30:00Z","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","received_at":"2026-05-13T14:30:01Z","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","subject_type":""}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/FulfillmentEventResponse"}}},"description":"The newly recorded fulfillment event.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Fulfillment record not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create fulfillment event","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/fulfillments/{fulfillment_id}/shipments":{"post":{"description":"Creates a shipment execution record under a shipment-type fulfillment. A shipment groups one carrier leg. Create one package under it for each physical parcel, including single-parcel shipments.","operationId":"createShipment","parameters":[{"description":"Flint shipment fulfillment ID.","in":"path","name":"fulfillment_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"external_reference_id":"ship_789","external_system":"merchant_wms","metadata":{"warehouse":"east"}},"schema":{"$ref":"#/components/schemas/CreateShipmentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"replayed":true,"shipment":{"created_at":"2026-05-13T15:59:00Z","direction":"outbound","external_reference_id":"ship_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","handed_off_at":"2026-05-13T16:00:00Z","metadata":{"warehouse":"east"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_count":0,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","shipped_at":"2026-05-13T16:00:00Z","status":"created","updated_at":"2026-05-13T16:00:00Z","version":1}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CreateShipmentResponse"}}},"description":"The replayed shipment for an existing provider reference.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"201":{"content":{"application/json":{"example":{"data":{"shipment":{"created_at":"2026-05-13T15:59:00Z","direction":"outbound","external_reference_id":"ship_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","handed_off_at":"2026-05-13T16:00:00Z","metadata":{"warehouse":"east"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_count":0,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","shipped_at":"2026-05-13T16:00:00Z","status":"created","updated_at":"2026-05-13T16:00:00Z","version":1}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CreateShipmentResponse"}}},"description":"The newly created shipment.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order or fulfillment not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create shipment","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/fulfillments/{fulfillment_id}/transitions":{"post":{"description":"Performs one action from the fulfillment's supported_actions. Each action accepts only its action-specific fields. expected_version is optional and rejects a stale resource version when supplied.","operationId":"transitionFulfillment","parameters":[{"description":"Flint fulfillment ID.","in":"path","name":"fulfillment_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"action":"mark_ready","buyer_notification_behavior":"send","expected_version":4},"schema":{"$ref":"#/components/schemas/FulfillmentTransitionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"event":{"buyer_notification_behavior":"send","created_at":"2026-05-13T14:30:01Z","current_status":"ready","event_type":"status_changed","fulfillment_event_id":"fev_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","occurred_at":"2026-05-13T14:30:00Z","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","previous_status":"in_progress","quantity_effect":"preserve","received_at":"2026-05-13T14:30:01Z","subject_type":"fulfillment"},"fulfillment":{"created_at":"2026-05-13T09:45:00Z","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","line_items":[{"order_line_item_id":"li_123","quantity":1}],"metadata":{"source":"dispatch"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","request_status":"accepted","status":"ready","supported_actions":["complete","cancel","fail"],"type":"shipment","updated_at":"2026-05-13T14:30:01Z","version":5}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/FulfillmentCommandResponse"}}},"description":"The fulfillment command result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order or fulfillment not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"FULFILLMENT_ACTION_NOT_ALLOWED","details":[{"code":"FULFILLMENT_ACTION_NOT_ALLOWED","current_resource":{"completed_at":"2026-05-13T14:30:00Z","created_at":"2026-05-13T09:45:00Z","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","line_items":[{"order_line_item_id":"li_123","quantity":1}],"metadata":{"source":"dispatch"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","request_status":"accepted","status":"completed","supported_actions":[],"type":"shipment","updated_at":"2026-05-13T14:30:00Z","version":4},"current_status":"completed","current_version":4,"message":"the action is not supported in the current status","param":"action","remediation":{"next_steps":"Read current_resource.supported_actions and choose one of the listed actions.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"action is not available for the fulfillment's current status; read supported_actions and retry","param":"action","remediation":{"next_steps":"Read current_resource.supported_actions and choose one of the listed actions.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Transition fulfillment","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","FIELD_REQUIRED","FULFILLMENT_ACTION_NOT_ALLOWED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_CHANGED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_QUANTITY_EFFECT_REQUIRED","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_STATUS_REASON_TOO_LONG","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INVALID_ACTION","INVALID_API_KEY","INVALID_EXPECTED_VERSION","INVALID_FIELD_TYPE","INVALID_FULFILLMENT_BUYER_NOTIFICATION_BEHAVIOR","INVALID_REQUEST","INVALID_TIMESTAMP","NULL_NOT_ALLOWED","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","UNKNOWN_FIELD"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/inventory-adjustments":{"get":{"description":"List inventory adjustments.","operationId":"listInventoryAdjustments","parameters":[{"description":"Number of resources to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Stable cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by inventory item.","in":"query","name":"inventory_item_id","required":false,"schema":{"type":"string"}},{"description":"Filter by Location.","in":"query","name":"location_id","required":false,"schema":{"type":"string"}},{"description":"Filter by adjustment reason.","in":"query","name":"reason","required":false,"schema":{"enum":["received_stock","damage","condition_changed","theft","loss","manual_correction","other"],"type":"string","x-enum-descriptions":["Received stock.","Damage.","Condition changed.","Theft.","Loss.","Manual correction.","Other."],"x-flint-enum":"closed"}},{"description":"Recover an adjustment by idempotency key.","in":"query","name":"idempotency_key","required":false,"schema":{"type":"string"}},{"description":"Filter by source-system type.","in":"query","name":"source_system_type","required":false,"schema":{"enum":["manual","pos","wms","erp","flint","other"],"type":"string","x-enum-descriptions":["Manual.","Pos.","Wms.","Erp.","Flint.","Other."],"x-flint-enum":"closed"}},{"description":"Filter by external source ID.","in":"query","name":"external_source_id","required":false,"schema":{"type":"string"}},{"description":"Filter by external actor ID.","in":"query","name":"external_actor_id","required":false,"schema":{"type":"string"}},{"description":"Lower bound for occurred_at.","in":"query","name":"occurred_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Upper bound for occurred_at.","in":"query","name":"occurred_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"created_at":"2026-07-21T14:18:04Z","external_actor_id":"receiver_204","idempotency_key":"receiving-1842","inventory_adjustment_id":"invadj_01K0P7W6A4N9F3J2T8Q5R1C6XM","lines":[{"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","on_hand_quantity_delta":25}],"note":"Receiving record 1842","occurred_at":"2026-07-21T14:18:00Z","reason":"received_stock","source_system":{"external_source_id":"east-coast-wms","type":"wms"}}],"next_page_token":"","request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryAdjustmentListResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List inventory adjustments","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.read","commerce.inventory.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Record a physical stock change as signed deltas. Returns the created adjustment, its movement IDs, and the resulting level for every level touched.","operationId":"createInventoryAdjustment","parameters":[{"description":"Required durable identity for this inventory command. The key is scoped to the authenticated merchant, environment, and endpoint; its fingerprint includes the canonical request body. Reuse it only for exact retries. Flint retains it for at least as long as the command's inventory effects, returns it in the response, and supports recovery through the relevant resource or movement list.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"external_actor_id":"receiver_204","lines":[{"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","on_hand_quantity_delta":25}],"note":"Receiving record 1842","occurred_at":"2026-07-21T14:18:00Z","reason":"received_stock","source_system":{"external_source_id":"east-coast-wms","type":"wms"}},"schema":{"$ref":"#/components/schemas/CreateInventoryAdjustmentRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"idempotency_key":"receiving-1842","inventory_adjustment":{"created_at":"2026-07-21T14:18:04Z","external_actor_id":"receiver_204","idempotency_key":"receiving-1842","inventory_adjustment_id":"invadj_01K0P7W6A4N9F3J2T8Q5R1C6XM","lines":[{"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","on_hand_quantity_delta":25}],"note":"Receiving record 1842","occurred_at":"2026-07-21T14:18:00Z","reason":"received_stock","source_system":{"external_source_id":"east-coast-wms","type":"wms"}},"inventory_movement_ids":["invm_01K0P7W6A4N9F3J2T8Q5R1C6XM"],"resulting_inventory_levels":[{"available_quantity":31,"committed_quantity":6,"created_at":"2026-05-02T11:04:00Z","damaged_quantity":2,"held_quantity":4,"incoming_quantity":0,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_claim_revision":7,"inventory_level_id":"invl_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_physical_revision":9,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","on_hand_quantity":48,"quality_control_quantity":0,"quarantined_quantity":0,"safety_stock_quantity":5,"shortage_quantity":0,"unavailable_on_hand_quantity":2,"updated_at":"2026-07-21T14:18:00Z","version":18}]},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryAdjustmentResultResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create inventory adjustment","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/inventory-allocation-policies":{"get":{"description":"List inventory allocation policies.","operationId":"listInventoryAllocationPolicies","parameters":[{"description":"Number of resources to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Stable cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by policy status.","in":"query","name":"status","required":false,"schema":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search allocation policy ID, external reference ID, or name.","in":"query","name":"query","required":false,"schema":{"maxLength":255,"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"configuration":{"location_groups":[{"group_priority":1,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM"},{"group_priority":2,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6YN"}],"maximum_locations_per_assignment":3,"splitting_behavior":"split_when_required","within_group_order":"location_id_ascending"},"created_at":"2026-06-01T10:00:00Z","inventory_allocation_policy_id":"invp_01K0P7W6A4N9F3J2T8Q5R1C6XM","metadata":{},"name":"US retail routing","status":"active","updated_at":"2026-06-01T10:00:00Z","version":2}],"next_page_token":"","request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryAllocationPolicyListResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List inventory allocation policies","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.read","commerce.inventory.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Create an allocation policy with its routing configuration.","operationId":"createInventoryAllocationPolicy","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"configuration":{"location_groups":[{"group_priority":1,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM"}],"maximum_locations_per_assignment":3,"splitting_behavior":"split_when_required","within_group_order":"location_id_ascending"},"name":"US retail routing","status":"active"},"schema":{"$ref":"#/components/schemas/CreateInventoryAllocationPolicyRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"configuration":{"location_groups":[{"group_priority":1,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM"},{"group_priority":2,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6YN"}],"maximum_locations_per_assignment":3,"splitting_behavior":"split_when_required","within_group_order":"location_id_ascending"},"created_at":"2026-06-01T10:00:00Z","inventory_allocation_policy_id":"invp_01K0P7W6A4N9F3J2T8Q5R1C6XM","metadata":{},"name":"US retail routing","status":"active","updated_at":"2026-06-01T10:00:00Z","version":2},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryAllocationPolicyResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create inventory allocation policy","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory_policies.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory_policies.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/inventory-allocation-policies/{inventory_allocation_policy_id}":{"delete":{"description":"Retire an allocation policy. keeps the archived resource available in list results.","operationId":"deleteInventoryAllocationPolicy","parameters":[{"description":"Flint inventory allocation policy ID.","in":"path","name":"inventory_allocation_policy_id","required":true,"schema":{"type":"string"}},{"description":"Current resource version used as a concurrency fence.","in":"query","name":"expected_version","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"configuration":{"location_groups":[{"group_priority":1,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM"},{"group_priority":2,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6YN"}],"maximum_locations_per_assignment":3,"splitting_behavior":"split_when_required","within_group_order":"location_id_ascending"},"created_at":"2026-06-01T10:00:00Z","inventory_allocation_policy_id":"invp_01K0P7W6A4N9F3J2T8Q5R1C6XM","metadata":{},"name":"US retail routing","status":"active","updated_at":"2026-06-01T10:00:00Z","version":2},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryAllocationPolicyResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Retire inventory allocation policy","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory_policies.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory_policies.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"patch":{"description":"Update policy fields, availability, or atomically replace its routing configuration. Send expected_version to reject concurrent changes.","operationId":"updateInventoryAllocationPolicy","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Flint inventory allocation policy ID.","in":"path","name":"inventory_allocation_policy_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"configuration":{"location_groups":[{"group_priority":1,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM"},{"group_priority":2,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6YN"}],"maximum_locations_per_assignment":3,"splitting_behavior":"split_when_required","within_group_order":"location_id_ascending"},"expected_version":2},"schema":{"$ref":"#/components/schemas/UpdateInventoryAllocationPolicyRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"configuration":{"location_groups":[{"group_priority":1,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM"},{"group_priority":2,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6YN"}],"maximum_locations_per_assignment":3,"splitting_behavior":"split_when_required","within_group_order":"location_id_ascending"},"created_at":"2026-06-01T10:00:00Z","inventory_allocation_policy_id":"invp_01K0P7W6A4N9F3J2T8Q5R1C6XM","metadata":{},"name":"US retail routing","status":"active","updated_at":"2026-06-01T10:00:00Z","version":2},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryAllocationPolicyResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update inventory allocation policy","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory_policies.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory_policies.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/inventory-counts":{"get":{"description":"List inventory counts.","operationId":"listInventoryCounts","parameters":[{"description":"Number of resources to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Stable cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by a counted inventory item.","in":"query","name":"inventory_item_id","required":false,"schema":{"type":"string"}},{"description":"Filter by Location.","in":"query","name":"location_id","required":false,"schema":{"type":"string"}},{"description":"Filter by count status.","in":"query","name":"status","required":false,"schema":{"enum":["draft","applied","canceled"],"type":"string","x-enum-descriptions":["Draft.","Applied.","Canceled."],"x-flint-enum":"open"}},{"description":"Recover a count by idempotency key.","in":"query","name":"idempotency_key","required":false,"schema":{"type":"string"}},{"description":"Lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Lower bound for applied_at.","in":"query","name":"applied_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Upper bound for applied_at.","in":"query","name":"applied_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"created_at":"2026-07-21T14:00:00Z","idempotency_key":"brooklyn-cycle-count-1842","inventory_count_id":"invc_01K0P7W6A4N9F3J2T8Q5R1C6XM","lines":[{"captured_physical_revision":9,"counted_damaged_quantity":2,"counted_on_hand_quantity":47,"counted_quality_control_quantity":1,"counted_quarantined_quantity":0,"inventory_count_line_id":"invcln_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","source_observation_sequence":1842}],"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","observation_provenance":{"external_actor_id":"counter_204","occurred_at":"2026-07-21T14:16:00Z","source_system":{"external_source_id":"east-coast-wms","type":"wms"}},"status":"draft","updated_at":"2026-07-21T14:16:04Z","version":2}],"next_page_token":"","request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryCountListResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List inventory counts","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.read","commerce.inventory.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Open a physical count for selected inventory items at one Location.","operationId":"createInventoryCount","parameters":[{"description":"Required durable identity for this inventory command. The key is scoped to the authenticated merchant, environment, and endpoint; its fingerprint includes the canonical request body. Reuse it only for exact retries. Flint retains it for at least as long as the command's inventory effects, returns it in the response, and supports recovery through the relevant resource or movement list.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"inventory_item_ids":["example"],"location_id":"loc_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/CreateInventoryCountRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"created_at":"2026-07-21T14:00:00Z","idempotency_key":"brooklyn-cycle-count-1842","inventory_count_id":"invc_01K0P7W6A4N9F3J2T8Q5R1C6XM","lines":[{"captured_physical_revision":9,"inventory_count_line_id":"invcln_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM"}],"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","status":"draft","updated_at":"2026-07-21T14:00:00Z","version":1},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryCountResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create inventory count","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/inventory-counts/{inventory_count_id}":{"patch":{"description":"Replace a count's observations atomically. Send expected_version to reject concurrent changes.","operationId":"updateInventoryCount","parameters":[{"description":"Required durable identity for this inventory command. The key is scoped to the authenticated merchant, environment, and endpoint; its fingerprint includes the canonical request body. Reuse it only for exact retries. Flint retains it for at least as long as the command's inventory effects, returns it in the response, and supports recovery through the relevant resource or movement list.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}},{"description":"Flint inventory count ID.","in":"path","name":"inventory_count_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"expected_version":2,"observations":[{"counted_damaged_quantity":0,"counted_on_hand_quantity":12,"counted_quality_control_quantity":0,"counted_quarantined_quantity":0,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM"}],"source_system":{"type":"manual"}},"schema":{"$ref":"#/components/schemas/UpdateInventoryCountRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-07-21T14:00:00Z","idempotency_key":"brooklyn-cycle-count-1842","inventory_count_id":"invc_01K0P7W6A4N9F3J2T8Q5R1C6XM","lines":[{"captured_physical_revision":9,"counted_damaged_quantity":2,"counted_on_hand_quantity":47,"counted_quality_control_quantity":1,"counted_quarantined_quantity":0,"inventory_count_line_id":"invcln_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","source_observation_sequence":1842}],"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","observation_provenance":{"external_actor_id":"counter_204","occurred_at":"2026-07-21T14:16:00Z","source_system":{"external_source_id":"east-coast-wms","type":"wms"}},"status":"draft","updated_at":"2026-07-21T14:16:04Z","version":2},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryCountResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update inventory count","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/inventory-counts/{inventory_count_id}/apply":{"post":{"description":"Apply a completed physical count to inventory levels.","operationId":"applyInventoryCount","parameters":[{"description":"Required durable identity for this inventory command. The key is scoped to the authenticated merchant, environment, and endpoint; its fingerprint includes the canonical request body. Reuse it only for exact retries. Flint retains it for at least as long as the command's inventory effects, returns it in the response, and supports recovery through the relevant resource or movement list.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}},{"description":"Flint inventory count ID.","in":"path","name":"inventory_count_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{},"schema":{"$ref":"#/components/schemas/InventoryCountTransitionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"idempotency_key":"brooklyn-cycle-count-1842-apply","inventory_count":{"applied_at":"2026-07-21T14:18:00Z","created_at":"2026-07-21T14:00:00Z","idempotency_key":"brooklyn-cycle-count-1842","inventory_count_id":"invc_01K0P7W6A4N9F3J2T8Q5R1C6XM","lines":[{"captured_physical_revision":9,"counted_damaged_quantity":2,"counted_on_hand_quantity":47,"counted_quality_control_quantity":1,"counted_quarantined_quantity":0,"damaged_variance":0,"inventory_count_line_id":"invcln_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_movement_id":"invm_01K0P7W6A4N9F3J2T8Q5R1C6XM","on_hand_variance":-1,"quality_control_variance":1,"quarantined_variance":0,"source_observation_sequence":1842}],"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","observation_provenance":{"external_actor_id":"counter_204","occurred_at":"2026-07-21T14:16:00Z","source_system":{"external_source_id":"east-coast-wms","type":"wms"}},"status":"applied","updated_at":"2026-07-21T14:18:00Z","version":3},"inventory_movement_ids":["invm_01K0P7W6A4N9F3J2T8Q5R1C6XM"],"resulting_inventory_levels":[{"available_quantity":29,"committed_quantity":6,"created_at":"2026-05-02T11:04:00Z","damaged_quantity":2,"held_quantity":4,"incoming_quantity":0,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_claim_revision":7,"inventory_level_id":"invl_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_physical_revision":10,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","on_hand_quantity":47,"quality_control_quantity":1,"quarantined_quantity":0,"safety_stock_quantity":5,"shortage_quantity":0,"unavailable_on_hand_quantity":3,"updated_at":"2026-07-21T14:18:00Z","version":19}]},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryCountResultResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Apply inventory count","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/inventory-counts/{inventory_count_id}/cancel":{"post":{"description":"Cancel an open physical count without changing inventory levels.","operationId":"cancelInventoryCount","parameters":[{"description":"Required durable identity for this inventory command. The key is scoped to the authenticated merchant, environment, and endpoint; its fingerprint includes the canonical request body. Reuse it only for exact retries. Flint retains it for at least as long as the command's inventory effects, returns it in the response, and supports recovery through the relevant resource or movement list.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}},{"description":"Flint inventory count ID.","in":"path","name":"inventory_count_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{},"schema":{"$ref":"#/components/schemas/InventoryCountTransitionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"idempotency_key":"brooklyn-cycle-count-1842-cancel","inventory_count":{"created_at":"2026-07-21T14:00:00Z","idempotency_key":"brooklyn-cycle-count-1842","inventory_count_id":"invc_01K0P7W6A4N9F3J2T8Q5R1C6XM","lines":[{"captured_physical_revision":9,"counted_damaged_quantity":2,"counted_on_hand_quantity":47,"counted_quality_control_quantity":1,"counted_quarantined_quantity":0,"inventory_count_line_id":"invcln_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","source_observation_sequence":1842}],"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","observation_provenance":{"external_actor_id":"counter_204","occurred_at":"2026-07-21T14:16:00Z","source_system":{"external_source_id":"east-coast-wms","type":"wms"}},"status":"canceled","updated_at":"2026-07-21T14:18:00Z","version":3},"inventory_movement_ids":[],"resulting_inventory_levels":[]},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryCountResultResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Cancel inventory count","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/inventory-items":{"get":{"description":"List inventory items.","operationId":"listInventoryItems","parameters":[{"description":"Number of resources to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Stable cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by inventory item status.","in":"query","name":"status","required":false,"schema":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"}},{"description":"Filter by exact SKU.","in":"query","name":"sku","required":false,"schema":{"type":"string"}},{"description":"Filter by exact barcode.","in":"query","name":"barcode","required":false,"schema":{"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search inventory item ID, external reference ID, name, SKU, or barcode.","in":"query","name":"query","required":false,"schema":{"maxLength":255,"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"barcode":"0781234567890","created_at":"2026-05-02T11:04:00Z","inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","metadata":{"supplier":"northwind"},"name":"Ceramic mug, 12oz","sku":"mug-12-white","status":"active","updated_at":"2026-07-14T09:12:00Z","version":3}],"next_page_token":"","request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryItemListResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List inventory items","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.read","commerce.inventory.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Create an inventory item. SKU and barcode are searchable attributes, not identity: they are not required to be unique.","operationId":"createInventoryItem","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"barcode":"0781234567890","name":"Ceramic mug, 12oz","sku":"mug-12-white","status":"active"},"schema":{"$ref":"#/components/schemas/CreateInventoryItemRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"barcode":"0781234567890","created_at":"2026-05-02T11:04:00Z","inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","metadata":{"supplier":"northwind"},"name":"Ceramic mug, 12oz","sku":"mug-12-white","status":"active","updated_at":"2026-07-14T09:12:00Z","version":3},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryItemResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create inventory item","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/inventory-items/{inventory_item_id}":{"delete":{"description":"Retire an inventory item. keeps the archived resource available in list results.","operationId":"deleteInventoryItem","parameters":[{"description":"Flint inventory item ID.","in":"path","name":"inventory_item_id","required":true,"schema":{"type":"string"}},{"description":"Current resource version used as a concurrency fence.","in":"query","name":"expected_version","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"barcode":"0781234567890","created_at":"2026-05-02T11:04:00Z","inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","metadata":{"supplier":"northwind"},"name":"Ceramic mug, 12oz","sku":"mug-12-white","status":"active","updated_at":"2026-07-14T09:12:00Z","version":3},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryItemResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Retire inventory item","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"patch":{"description":"Update an inventory item. accepts status active or inactive. Send sku or barcode as null to clear.","operationId":"updateInventoryItem","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Flint inventory item ID.","in":"path","name":"inventory_item_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"barcode":null,"expected_version":3,"name":"Ceramic mug, 12oz (white)"},"schema":{"$ref":"#/components/schemas/UpdateInventoryItemRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"barcode":"0781234567890","created_at":"2026-05-02T11:04:00Z","inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","metadata":{"supplier":"northwind"},"name":"Ceramic mug, 12oz","sku":"mug-12-white","status":"active","updated_at":"2026-07-14T09:12:00Z","version":3},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryItemResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update inventory item","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/inventory-levels":{"get":{"description":"List inventory levels. Each level carries the inventory item's name, SKU, barcode, and status under inventory_item, so a stock table needs no read per row. Levels are strongly consistent individually, but pages may reflect different committed instants.","operationId":"listInventoryLevels","parameters":[{"description":"Number of resources to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Stable cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by inventory item.","in":"query","name":"inventory_item_id","required":false,"schema":{"type":"string"}},{"description":"Filter by Location.","in":"query","name":"location_id","required":false,"schema":{"type":"string"}},{"description":"Only include levels with available quantity.","in":"query","name":"has_available_quantity","required":false,"schema":{"type":"boolean"}},{"description":"Only include levels with unavailable physical stock.","in":"query","name":"has_unavailable_condition","required":false,"schema":{"type":"boolean"}},{"description":"Only include levels with a shortage.","in":"query","name":"has_shortage","required":false,"schema":{"type":"boolean"}},{"description":"Search inventory item ID, name, SKU, or barcode. Case-insensitive substring match.","in":"query","name":"query","required":false,"schema":{"maxLength":255,"type":"string"}},{"description":"Inclusive lower bound for available_quantity.","in":"query","name":"min_available_quantity","required":false,"schema":{"format":"int64","minimum":0,"type":"integer"}},{"description":"Inclusive upper bound for available_quantity.","in":"query","name":"max_available_quantity","required":false,"schema":{"format":"int64","minimum":0,"type":"integer"}},{"description":"Lower bound for updated_at.","in":"query","name":"updated_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Upper bound for updated_at.","in":"query","name":"updated_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"available_quantity":31,"committed_quantity":6,"created_at":"2026-05-02T11:04:00Z","damaged_quantity":2,"held_quantity":4,"incoming_quantity":0,"inventory_item":{"barcode":"0781234567890","name":"Ceramic mug, 12oz","sku":"mug-12-white","status":"active"},"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_claim_revision":7,"inventory_level_id":"invl_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_physical_revision":9,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","on_hand_quantity":48,"quality_control_quantity":0,"quarantined_quantity":0,"safety_stock_quantity":5,"shortage_quantity":0,"unavailable_on_hand_quantity":2,"updated_at":"2026-07-21T14:18:00Z","version":18}],"next_page_token":"","request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryLevelListResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List inventory levels","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_BOOLEAN","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.read","commerce.inventory.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/inventory-levels/{inventory_level_id}":{"patch":{"description":"Set one inventory level's safety_stock_quantity. returns the updated level with durable command evidence.","operationId":"updateInventoryLevel","parameters":[{"description":"Required durable identity for this inventory command. The key is scoped to the authenticated merchant, environment, and endpoint; its fingerprint includes the canonical request body. Reuse it only for exact retries. Flint retains it for at least as long as the command's inventory effects, returns it in the response, and supports recovery through the relevant resource or movement list.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}},{"description":"Flint inventory level ID.","in":"path","name":"inventory_level_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"expected_version":4,"safety_stock_quantity":5},"schema":{"$ref":"#/components/schemas/UpdateInventoryLevelRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"idempotency_key":"receiving-1842","inventory_level":{"available_quantity":31,"committed_quantity":6,"created_at":"2026-05-02T11:04:00Z","damaged_quantity":2,"held_quantity":4,"incoming_quantity":0,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_claim_revision":7,"inventory_level_id":"invl_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_physical_revision":9,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","on_hand_quantity":48,"quality_control_quantity":0,"quarantined_quantity":0,"safety_stock_quantity":5,"shortage_quantity":0,"unavailable_on_hand_quantity":2,"updated_at":"2026-07-21T14:18:00Z","version":18},"inventory_movement_ids":["invm_01K0P7W6A4N9F3J2T8Q5R1C6XM"],"resulting_inventory_levels":[{"available_quantity":31,"committed_quantity":6,"created_at":"2026-05-02T11:04:00Z","damaged_quantity":2,"held_quantity":4,"incoming_quantity":0,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_claim_revision":7,"inventory_level_id":"invl_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_physical_revision":9,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","on_hand_quantity":48,"quality_control_quantity":0,"quarantined_quantity":0,"safety_stock_quantity":5,"shortage_quantity":0,"unavailable_on_hand_quantity":2,"updated_at":"2026-07-21T14:18:00Z","version":18}]},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryLevelUpdateResultResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update inventory level","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/inventory-movements":{"get":{"description":"List inventory movements. Filter by idempotency_key to recover the movements a command produced. Send order=desc to read the newest movements first.","operationId":"listInventoryMovements","parameters":[{"description":"Number of resources to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Stable cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by inventory item.","in":"query","name":"inventory_item_id","required":false,"schema":{"type":"string"}},{"description":"Filter by Location.","in":"query","name":"location_id","required":false,"schema":{"type":"string"}},{"description":"Filter by movement type.","in":"query","name":"type","required":false,"schema":{"type":"string"}},{"description":"Filter by movement reason.","in":"query","name":"reason","required":false,"schema":{"type":"string"}},{"description":"Recover movements by command idempotency key.","in":"query","name":"idempotency_key","required":false,"schema":{"type":"string"}},{"description":"Filter by the customer Return that produced the movement.","in":"query","name":"return_id","required":false,"schema":{"type":"string"}},{"description":"Filter by the Return disposition that produced the movement.","in":"query","name":"return_disposition_id","required":false,"schema":{"type":"string"}},{"description":"Order of the resource ID the list paginates by.","in":"query","name":"order","required":false,"schema":{"default":"asc","enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"Filter by source-system type.","in":"query","name":"source_system_type","required":false,"schema":{"enum":["manual","pos","wms","erp","flint","other"],"type":"string","x-enum-descriptions":["Manual.","Pos.","Wms.","Erp.","Flint.","Other."],"x-flint-enum":"closed"}},{"description":"Filter by external source ID.","in":"query","name":"external_source_id","required":false,"schema":{"type":"string"}},{"description":"Filter by external actor ID.","in":"query","name":"external_actor_id","required":false,"schema":{"type":"string"}},{"description":"Lower bound for occurred_at.","in":"query","name":"occurred_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Upper bound for occurred_at.","in":"query","name":"occurred_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Filter by source-reference type.","in":"query","name":"source_reference_type","required":false,"schema":{"type":"string"}},{"description":"Filter by source-reference ID.","in":"query","name":"source_reference_id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"created_at":"2026-07-21T14:18:04Z","created_by":"usr_01K0P7W6A4N9F3J2T8Q5R1C6XM","external_actor_id":"receiver_204","idempotency_key":"receiving-1842","inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_claim_revision":7,"inventory_level_id":"invl_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_physical_revision":9,"inventory_level_revision":18,"inventory_movement_id":"invm_01K0P7W6A4N9F3J2T8Q5R1C6XM","location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","note":"Receiving record 1842","occurred_at":"2026-07-21T14:18:00Z","on_hand_quantity_delta":25,"reason":"received_stock","resulting_inventory_level":{"available_quantity":31,"committed_quantity":6,"created_at":"2026-05-02T11:04:00Z","damaged_quantity":2,"held_quantity":4,"incoming_quantity":0,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_claim_revision":7,"inventory_level_id":"invl_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_physical_revision":9,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","on_hand_quantity":48,"quality_control_quantity":0,"quarantined_quantity":0,"safety_stock_quantity":5,"shortage_quantity":0,"unavailable_on_hand_quantity":2,"updated_at":"2026-07-21T14:18:00Z","version":18},"source_system":{"external_source_id":"east-coast-wms","type":"wms"},"type":"adjustment"}],"next_page_token":"","request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryMovementListResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List inventory movements","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.read","commerce.inventory.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/inventory-receipts":{"get":{"description":"List completed inventory receipt effects. Use typed Return filters for reconciliation when the receipt was created by Returns.","operationId":"listInventoryReceipts","parameters":[{"description":"Number of resources to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Stable cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by inventory item.","in":"query","name":"inventory_item_id","required":false,"schema":{"type":"string"}},{"description":"Filter by receiving Location.","in":"query","name":"receiving_location_id","required":false,"schema":{"type":"string"}},{"description":"Filter by source reservation.","in":"query","name":"inventory_reservation_id","required":false,"schema":{"type":"string"}},{"description":"Filter by the customer Return that produced the receipt.","in":"query","name":"return_id","required":false,"schema":{"type":"string"}},{"description":"Filter by the Return disposition that produced the receipt.","in":"query","name":"return_disposition_id","required":false,"schema":{"type":"string"}},{"description":"Recover a receipt by command idempotency key.","in":"query","name":"idempotency_key","required":false,"schema":{"type":"string"}},{"description":"Filter by source-system type.","in":"query","name":"source_system_type","required":false,"schema":{"enum":["manual","pos","wms","erp","flint","other"],"type":"string","x-enum-descriptions":["Manual.","Pos.","Wms.","Erp.","Flint.","Other."],"x-flint-enum":"closed"}},{"description":"Filter by external source ID.","in":"query","name":"external_source_id","required":false,"schema":{"type":"string"}},{"description":"Filter by external actor ID.","in":"query","name":"external_actor_id","required":false,"schema":{"type":"string"}},{"description":"Lower bound for occurred_at.","in":"query","name":"occurred_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Upper bound for occurred_at.","in":"query","name":"occurred_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"created_at":"2026-07-21T14:18:04Z","idempotency_key":"retdsp_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_receipt_id":"invrec_01K0P7W6A4N9F3J2T8Q5R1C6XM","lines":[{"disposition":"sellable","inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_movement_id":"invm_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_receipt_line_id":"invrecln_01K0P7W6A4N9F3J2T8Q5R1C6XM","quantity":1,"receiving_location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","return_disposition_id":"retdsp_01K0P7W6A4N9F3J2T8Q5R1C6XM","return_line_item_id":"retli_01K0P7W6A4N9F3J2T8Q5R1C6XM"}],"occurred_at":"2026-07-21T14:18:00Z","return_disposition_id":"retdsp_01K0P7W6A4N9F3J2T8Q5R1C6XM","return_id":"ret_01K0P7W6A4N9F3J2T8Q5R1C6XM","source_system":{"type":"flint"}}],"next_page_token":"","request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryReceiptListResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List inventory receipts","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.read","commerce.inventory.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Record a completed inventory receipt and disposition. This is a downstream stock effect, not the customer Return lifecycle.","operationId":"createInventoryReceipt","parameters":[{"description":"Required durable identity for this inventory command. The key is scoped to the authenticated merchant, environment, and endpoint; its fingerprint includes the canonical request body. Reuse it only for exact retries. Flint retains it for at least as long as the command's inventory effects, returns it in the response, and supports recovery through the relevant resource or movement list.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"external_actor_id":"receiver_204","lines":[{"disposition":"sellable","inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","quantity":1,"receiving_location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM"}],"occurred_at":"2026-07-21T14:18:00Z","source_system":{"external_source_id":"east-coast-wms","type":"wms"}},"schema":{"$ref":"#/components/schemas/CreateInventoryReceiptRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"idempotency_key":"receiving-1842","inventory_movement_ids":["invm_01K0P7W6A4N9F3J2T8Q5R1C6XM"],"inventory_receipt":{"created_at":"2026-07-21T14:18:04Z","idempotency_key":"retdsp_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_receipt_id":"invrec_01K0P7W6A4N9F3J2T8Q5R1C6XM","lines":[{"disposition":"sellable","inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_movement_id":"invm_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_receipt_line_id":"invrecln_01K0P7W6A4N9F3J2T8Q5R1C6XM","quantity":1,"receiving_location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","return_disposition_id":"retdsp_01K0P7W6A4N9F3J2T8Q5R1C6XM","return_line_item_id":"retli_01K0P7W6A4N9F3J2T8Q5R1C6XM"}],"occurred_at":"2026-07-21T14:18:00Z","return_disposition_id":"retdsp_01K0P7W6A4N9F3J2T8Q5R1C6XM","return_id":"ret_01K0P7W6A4N9F3J2T8Q5R1C6XM","source_system":{"type":"flint"}},"resulting_inventory_levels":[{"available_quantity":31,"committed_quantity":6,"created_at":"2026-05-02T11:04:00Z","damaged_quantity":2,"held_quantity":4,"incoming_quantity":0,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_claim_revision":7,"inventory_level_id":"invl_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_physical_revision":9,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","on_hand_quantity":48,"quality_control_quantity":0,"quarantined_quantity":0,"safety_stock_quantity":5,"shortage_quantity":0,"unavailable_on_hand_quantity":2,"updated_at":"2026-07-21T14:18:00Z","version":18}]},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryReceiptResultResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create inventory receipt","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/inventory-reservations":{"get":{"description":"List inventory reservations.","operationId":"listInventoryReservations","parameters":[{"description":"Number of resources to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Stable cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by reservation status.","in":"query","name":"status","required":false,"schema":{"enum":["active","closed"],"type":"string","x-enum-descriptions":["Active.","Closed."],"x-flint-enum":"open"}},{"description":"Filter by owner type.","in":"query","name":"owner_type","required":false,"schema":{"enum":["merchant"],"type":"string","x-enum-descriptions":["Merchant."],"x-flint-enum":"closed"}},{"description":"Filter by exact owner key.","in":"query","name":"owner_key","required":false,"schema":{"type":"string"}},{"description":"Recover a reservation by idempotency key.","in":"query","name":"idempotency_key","required":false,"schema":{"type":"string"}},{"description":"Only include reservations with at-risk quantity.","in":"query","name":"has_at_risk_quantity","required":false,"schema":{"type":"boolean"}},{"description":"Filter by how the reservation ended.","in":"query","name":"closed_reason","required":false,"schema":{"enum":["consumed","released","expired","reallocated","mixed"],"type":"string","x-enum-descriptions":["Consumed.","Released.","Expired.","Reallocated.","Mixed."],"x-flint-enum":"closed"}},{"description":"Lower bound for the owner deadline.","in":"query","name":"owner_expires_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Upper bound for the owner deadline.","in":"query","name":"owner_expires_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Lower bound for updated_at.","in":"query","name":"updated_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Upper bound for updated_at.","in":"query","name":"updated_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"created_at":"2026-07-21T14:18:00Z","idempotency_key":"cart-1842-hold","inventory_reservation_id":"invr_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_routing_source":{"inventory_allocation_policy_version_id":"invpv_01K0P7W6A4N9F3J2T8Q5R1C6XM","type":"policy_version"},"lines":[{"allocated_quantity":3,"at_risk_committed_quantity":0,"at_risk_held_quantity":0,"committed_quantity":2,"consumed_quantity":0,"demand_key":"cart_line_1","geography_revision":2,"held_quantity":1,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_reservation_line_id":"invrln_01K0P7W6A4N9F3J2T8Q5R1C6XM","location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","reallocated_quantity":0,"released_from_committed_quantity":0,"released_from_held_quantity":0}],"owner":{"expires_at":"2026-07-21T14:33:00Z","key":"cart_1842","type":"merchant"},"status":"active","updated_at":"2026-07-21T14:21:00Z","version":4}],"next_page_token":"","request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryReservationListResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List inventory reservations","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_BOOLEAN","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.read","commerce.inventory.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Route standalone merchant demand and hold stock in one atomic command. A provisional hold lasts at most 15 minutes.","operationId":"createInventoryReservation","parameters":[{"description":"Required durable identity for this inventory command. The key is scoped to the authenticated merchant, environment, and endpoint; its fingerprint includes the canonical request body. Reuse it only for exact retries. Flint retains it for at least as long as the command's inventory effects, returns it in the response, and supports recovery through the relevant resource or movement list.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"demands":[{"demand_key":"cart_line_1","inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","quantity":2,"splitting_behavior":"single_location"}],"inventory_routing_source":{"inventory_allocation_policy_version_id":"invpv_01K0P7W6A4N9F3J2T8Q5R1C6XM","type":"policy_version"},"owner":{"expires_at":"2026-07-21T14:33:00Z","key":"cart_1842","type":"merchant"}},"schema":{"$ref":"#/components/schemas/CreateInventoryReservationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"idempotency_key":"cart-1842-hold","inventory_movement_ids":["invm_01K0P7W6A4N9F3J2T8Q5R1C6XM"],"inventory_reservation":{"created_at":"2026-07-21T14:18:00Z","idempotency_key":"cart-1842-hold","inventory_reservation_id":"invr_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_routing_source":{"inventory_allocation_policy_version_id":"invpv_01K0P7W6A4N9F3J2T8Q5R1C6XM","type":"policy_version"},"lines":[{"allocated_quantity":3,"at_risk_committed_quantity":0,"at_risk_held_quantity":0,"committed_quantity":2,"consumed_quantity":0,"demand_key":"cart_line_1","geography_revision":2,"held_quantity":1,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_reservation_line_id":"invrln_01K0P7W6A4N9F3J2T8Q5R1C6XM","location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","reallocated_quantity":0,"released_from_committed_quantity":0,"released_from_held_quantity":0}],"owner":{"expires_at":"2026-07-21T14:33:00Z","key":"cart_1842","type":"merchant"},"status":"active","updated_at":"2026-07-21T14:21:00Z","version":4},"resulting_inventory_levels":[{"available_quantity":31,"committed_quantity":6,"created_at":"2026-05-02T11:04:00Z","damaged_quantity":2,"held_quantity":4,"incoming_quantity":0,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_claim_revision":7,"inventory_level_id":"invl_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_physical_revision":9,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","on_hand_quantity":48,"quality_control_quantity":0,"quarantined_quantity":0,"safety_stock_quantity":5,"shortage_quantity":0,"unavailable_on_hand_quantity":2,"updated_at":"2026-07-21T14:18:00Z","version":18}]},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryReservationResultResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create inventory reservation","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory_reservations.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory_reservations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/inventory-reservations/{inventory_reservation_id}/commit":{"post":{"description":"Move held quantity to committed. Lines carry cumulative targets, so resending an applied target is a successful no-op.","operationId":"commitInventoryReservation","parameters":[{"description":"Required durable identity for this inventory command. The key is scoped to the authenticated merchant, environment, and endpoint; its fingerprint includes the canonical request body. Reuse it only for exact retries. Flint retains it for at least as long as the command's inventory effects, returns it in the response, and supports recovery through the relevant resource or movement list.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}},{"description":"Flint inventory reservation ID.","in":"path","name":"inventory_reservation_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"expected_version":3,"lines":[{"inventory_reservation_line_id":"invrln_01K0P7W6A4N9F3J2T8Q5R1C6XM","target_committed_quantity":2}]},"schema":{"$ref":"#/components/schemas/CommitInventoryReservationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"idempotency_key":"cart-1842-hold","inventory_movement_ids":["invm_01K0P7W6A4N9F3J2T8Q5R1C6XM"],"inventory_reservation":{"created_at":"2026-07-21T14:18:00Z","idempotency_key":"cart-1842-hold","inventory_reservation_id":"invr_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_routing_source":{"inventory_allocation_policy_version_id":"invpv_01K0P7W6A4N9F3J2T8Q5R1C6XM","type":"policy_version"},"lines":[{"allocated_quantity":3,"at_risk_committed_quantity":0,"at_risk_held_quantity":0,"committed_quantity":2,"consumed_quantity":0,"demand_key":"cart_line_1","geography_revision":2,"held_quantity":1,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_reservation_line_id":"invrln_01K0P7W6A4N9F3J2T8Q5R1C6XM","location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","reallocated_quantity":0,"released_from_committed_quantity":0,"released_from_held_quantity":0}],"owner":{"expires_at":"2026-07-21T14:33:00Z","key":"cart_1842","type":"merchant"},"status":"active","updated_at":"2026-07-21T14:21:00Z","version":4},"resulting_inventory_levels":[{"available_quantity":31,"committed_quantity":6,"created_at":"2026-05-02T11:04:00Z","damaged_quantity":2,"held_quantity":4,"incoming_quantity":0,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_claim_revision":7,"inventory_level_id":"invl_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_physical_revision":9,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","on_hand_quantity":48,"quality_control_quantity":0,"quarantined_quantity":0,"safety_stock_quantity":5,"shortage_quantity":0,"unavailable_on_hand_quantity":2,"updated_at":"2026-07-21T14:18:00Z","version":18}]},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryReservationResultResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Commit inventory reservation","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory_reservations.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory_reservations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/inventory-reservations/{inventory_reservation_id}/consume":{"post":{"description":"Consume committed quantity, permanently removing it from stock. Cumulative targets; consumed quantity is terminal.","operationId":"consumeInventoryReservation","parameters":[{"description":"Required durable identity for this inventory command. The key is scoped to the authenticated merchant, environment, and endpoint; its fingerprint includes the canonical request body. Reuse it only for exact retries. Flint retains it for at least as long as the command's inventory effects, returns it in the response, and supports recovery through the relevant resource or movement list.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}},{"description":"Flint inventory reservation ID.","in":"path","name":"inventory_reservation_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"expected_version":5,"lines":[{"inventory_reservation_line_id":"invrln_01K0P7W6A4N9F3J2T8Q5R1C6XM","target_consumed_quantity":2}],"provenance":{"occurred_at":"2026-07-21T15:40:00Z","source_system":{"external_source_id":"east-coast-wms","type":"wms"}}},"schema":{"$ref":"#/components/schemas/ConsumeInventoryReservationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"idempotency_key":"cart-1842-hold","inventory_movement_ids":["invm_01K0P7W6A4N9F3J2T8Q5R1C6XM"],"inventory_reservation":{"created_at":"2026-07-21T14:18:00Z","idempotency_key":"cart-1842-hold","inventory_reservation_id":"invr_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_routing_source":{"inventory_allocation_policy_version_id":"invpv_01K0P7W6A4N9F3J2T8Q5R1C6XM","type":"policy_version"},"lines":[{"allocated_quantity":3,"at_risk_committed_quantity":0,"at_risk_held_quantity":0,"committed_quantity":2,"consumed_quantity":0,"demand_key":"cart_line_1","geography_revision":2,"held_quantity":1,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_reservation_line_id":"invrln_01K0P7W6A4N9F3J2T8Q5R1C6XM","location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","reallocated_quantity":0,"released_from_committed_quantity":0,"released_from_held_quantity":0}],"owner":{"expires_at":"2026-07-21T14:33:00Z","key":"cart_1842","type":"merchant"},"status":"active","updated_at":"2026-07-21T14:21:00Z","version":4},"resulting_inventory_levels":[{"available_quantity":31,"committed_quantity":6,"created_at":"2026-05-02T11:04:00Z","damaged_quantity":2,"held_quantity":4,"incoming_quantity":0,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_claim_revision":7,"inventory_level_id":"invl_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_physical_revision":9,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","on_hand_quantity":48,"quality_control_quantity":0,"quarantined_quantity":0,"safety_stock_quantity":5,"shortage_quantity":0,"unavailable_on_hand_quantity":2,"updated_at":"2026-07-21T14:18:00Z","version":18}]},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryReservationResultResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Consume inventory reservation","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory_reservations.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory_reservations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/inventory-reservations/{inventory_reservation_id}/release":{"post":{"description":"Release held or committed quantity back to available. Cumulative targets; released quantity is terminal.","operationId":"releaseInventoryReservation","parameters":[{"description":"Required durable identity for this inventory command. The key is scoped to the authenticated merchant, environment, and endpoint; its fingerprint includes the canonical request body. Reuse it only for exact retries. Flint retains it for at least as long as the command's inventory effects, returns it in the response, and supports recovery through the relevant resource or movement list.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}},{"description":"Flint inventory reservation ID.","in":"path","name":"inventory_reservation_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"expected_version":4,"lines":[{"inventory_reservation_line_id":"invrln_01K0P7W6A4N9F3J2T8Q5R1C6XM","target_released_from_held_quantity":1}]},"schema":{"$ref":"#/components/schemas/ReleaseInventoryReservationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"idempotency_key":"cart-1842-hold","inventory_movement_ids":["invm_01K0P7W6A4N9F3J2T8Q5R1C6XM"],"inventory_reservation":{"created_at":"2026-07-21T14:18:00Z","idempotency_key":"cart-1842-hold","inventory_reservation_id":"invr_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_routing_source":{"inventory_allocation_policy_version_id":"invpv_01K0P7W6A4N9F3J2T8Q5R1C6XM","type":"policy_version"},"lines":[{"allocated_quantity":3,"at_risk_committed_quantity":0,"at_risk_held_quantity":0,"committed_quantity":2,"consumed_quantity":0,"demand_key":"cart_line_1","geography_revision":2,"held_quantity":1,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_reservation_line_id":"invrln_01K0P7W6A4N9F3J2T8Q5R1C6XM","location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","reallocated_quantity":0,"released_from_committed_quantity":0,"released_from_held_quantity":0}],"owner":{"expires_at":"2026-07-21T14:33:00Z","key":"cart_1842","type":"merchant"},"status":"active","updated_at":"2026-07-21T14:21:00Z","version":4},"resulting_inventory_levels":[{"available_quantity":31,"committed_quantity":6,"created_at":"2026-05-02T11:04:00Z","damaged_quantity":2,"held_quantity":4,"incoming_quantity":0,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_claim_revision":7,"inventory_level_id":"invl_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_physical_revision":9,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","on_hand_quantity":48,"quality_control_quantity":0,"quarantined_quantity":0,"safety_stock_quantity":5,"shortage_quantity":0,"unavailable_on_hand_quantity":2,"updated_at":"2026-07-21T14:18:00Z","version":18}]},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryReservationResultResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Release inventory reservation","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory_reservations.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory_reservations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/inventory-transfers":{"get":{"description":"List inventory transfers.","operationId":"listInventoryTransfers","parameters":[{"description":"Number of resources to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Stable cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by inventory item.","in":"query","name":"inventory_item_id","required":false,"schema":{"type":"string"}},{"description":"Filter by origin Location.","in":"query","name":"origin_location_id","required":false,"schema":{"type":"string"}},{"description":"Filter by destination Location.","in":"query","name":"destination_location_id","required":false,"schema":{"type":"string"}},{"description":"Filter by transfer status.","in":"query","name":"status","required":false,"schema":{"enum":["draft","in_transit","partially_resolved","closed"],"type":"string","x-enum-descriptions":["Draft.","In transit.","Partially resolved.","Closed."],"x-flint-enum":"open"}},{"description":"Recover a transfer by idempotency key.","in":"query","name":"idempotency_key","required":false,"schema":{"type":"string"}},{"description":"Filter by caller-owned external reference.","in":"query","name":"external_reference","required":false,"schema":{"maxLength":255,"type":"string"}},{"description":"Search by inventory transfer ID, external reference, or note.","in":"query","name":"query","required":false,"schema":{"maxLength":255,"type":"string"}},{"description":"Filter by how the transfer ended.","in":"query","name":"closed_reason","required":false,"schema":{"enum":["received","canceled","received_with_cancellation","returned","lost","mixed"],"type":"string","x-enum-descriptions":["Received.","Canceled.","Received with cancellation.","Returned.","Lost.","Mixed."],"x-flint-enum":"closed"}},{"description":"Lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Lower bound for departed_at.","in":"query","name":"departed_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Upper bound for departed_at.","in":"query","name":"departed_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Lower bound for received_at.","in":"query","name":"received_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Upper bound for received_at.","in":"query","name":"received_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"created_at":"2026-07-21T14:00:00Z","destination_location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6YN","external_reference":"wms-transfer-1842","idempotency_key":"brooklyn-to-queens-1842","inventory_transfer_id":"invtr_01K0P7W6A4N9F3J2T8Q5R1C6XM","lines":[{"canceled_quantity":0,"departed_quantity":0,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_transfer_line_id":"invtrln_01K0P7W6A4N9F3J2T8Q5R1C6XM","lost_quantity":0,"physical_condition":"sellable","received_damaged_quantity":0,"received_quality_control_quantity":0,"received_quantity":0,"received_quarantined_quantity":0,"received_sellable_quantity":0,"requested_quantity":12,"returned_quantity":0}],"note":"Rebalance mug stock","origin_location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","status":"draft","supported_actions":["depart","cancel"],"updated_at":"2026-07-21T14:00:00Z","version":2}],"next_page_token":"","request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryTransferListResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List inventory transfers","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.read","commerce.inventory.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Create a planned stock transfer between two Locations.","operationId":"createInventoryTransfer","parameters":[{"description":"Required durable identity for this inventory command. The key is scoped to the authenticated merchant, environment, and endpoint; its fingerprint includes the canonical request body. Reuse it only for exact retries. Flint retains it for at least as long as the command's inventory effects, returns it in the response, and supports recovery through the relevant resource or movement list.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"destination_location_id":"example","lines":[{"inventory_item_id":"example","requested_quantity":1}],"origin_location_id":"example"},"schema":{"$ref":"#/components/schemas/CreateInventoryTransferRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"created_at":"2026-07-21T14:00:00Z","destination_location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6YN","external_reference":"wms-transfer-1842","idempotency_key":"brooklyn-to-queens-1842","inventory_transfer_id":"invtr_01K0P7W6A4N9F3J2T8Q5R1C6XM","lines":[{"canceled_quantity":0,"departed_quantity":0,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_transfer_line_id":"invtrln_01K0P7W6A4N9F3J2T8Q5R1C6XM","lost_quantity":0,"physical_condition":"sellable","received_damaged_quantity":0,"received_quality_control_quantity":0,"received_quantity":0,"received_quarantined_quantity":0,"received_sellable_quantity":0,"requested_quantity":12,"returned_quantity":0}],"note":"Rebalance mug stock","origin_location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","status":"draft","supported_actions":["depart","cancel"],"updated_at":"2026-07-21T14:00:00Z","version":1},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryTransferResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create inventory transfer","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/inventory-transfers/{inventory_transfer_id}":{"patch":{"description":"Update an open transfer's planning details.","operationId":"updateInventoryTransfer","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Flint inventory transfer ID.","in":"path","name":"inventory_transfer_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{},"schema":{"$ref":"#/components/schemas/UpdateInventoryTransferRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-07-21T14:00:00Z","destination_location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6YN","external_reference":"wms-transfer-1842","idempotency_key":"brooklyn-to-queens-1842","inventory_transfer_id":"invtr_01K0P7W6A4N9F3J2T8Q5R1C6XM","lines":[{"canceled_quantity":0,"departed_quantity":0,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_transfer_line_id":"invtrln_01K0P7W6A4N9F3J2T8Q5R1C6XM","lost_quantity":0,"physical_condition":"sellable","received_damaged_quantity":0,"received_quality_control_quantity":0,"received_quantity":0,"received_quarantined_quantity":0,"received_sellable_quantity":0,"requested_quantity":12,"returned_quantity":0}],"note":"Rebalance mug stock","origin_location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","status":"draft","supported_actions":["depart","cancel"],"updated_at":"2026-07-21T14:00:00Z","version":2},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryTransferResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update inventory transfer","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/inventory-transfers/{inventory_transfer_id}/transitions":{"post":{"description":"Run one action from supported_actions using cumulative line targets. Send expected_version to reject the request if the transfer changed after you read it. The response includes the updated transfer and its inventory effects.","operationId":"transitionInventoryTransfer","parameters":[{"description":"Required durable identity for this inventory command. The key is scoped to the authenticated merchant, environment, and endpoint; its fingerprint includes the canonical request body. Reuse it only for exact retries. Flint retains it for at least as long as the command's inventory effects, returns it in the response, and supports recovery through the relevant resource or movement list.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}},{"description":"Flint inventory transfer ID.","in":"path","name":"inventory_transfer_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"action":"depart","expected_version":2,"lines":[{"inventory_transfer_line_id":"invtrln_01K0P7W6A4N9F3J2T8Q5R1C6XM","target_departed_quantity":4}],"provenance":{"source_system":{"type":"manual"}}},"schema":{"$ref":"#/components/schemas/InventoryTransferTransitionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"idempotency_key":"brooklyn-to-queens-1842-depart","inventory_movement_ids":["invm_01K0P7W6A4N9F3J2T8Q5R1C7YP","invm_01K0P7W6A4N9F3J2T8Q5R1C8ZQ"],"inventory_transfer":{"created_at":"2026-07-21T14:00:00Z","departed_at":"2026-07-21T14:18:00Z","destination_location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6YN","external_reference":"wms-transfer-1842","idempotency_key":"brooklyn-to-queens-1842","inventory_transfer_id":"invtr_01K0P7W6A4N9F3J2T8Q5R1C6XM","lines":[{"canceled_quantity":0,"departed_quantity":12,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_transfer_line_id":"invtrln_01K0P7W6A4N9F3J2T8Q5R1C6XM","lost_quantity":0,"physical_condition":"sellable","received_damaged_quantity":0,"received_quality_control_quantity":0,"received_quantity":0,"received_quarantined_quantity":0,"received_sellable_quantity":0,"requested_quantity":12,"returned_quantity":0}],"note":"Rebalance mug stock","origin_location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","status":"in_transit","supported_actions":["receive","return_to_origin","report_loss"],"updated_at":"2026-07-21T14:18:00Z","version":3},"resulting_inventory_levels":[{"available_quantity":19,"committed_quantity":6,"created_at":"2026-05-02T11:04:00Z","damaged_quantity":2,"held_quantity":4,"incoming_quantity":0,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_claim_revision":7,"inventory_level_id":"invl_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_physical_revision":10,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","on_hand_quantity":36,"quality_control_quantity":0,"quarantined_quantity":0,"safety_stock_quantity":5,"shortage_quantity":0,"unavailable_on_hand_quantity":2,"updated_at":"2026-07-21T14:18:00Z","version":19},{"available_quantity":0,"committed_quantity":0,"created_at":"2026-07-21T14:18:00Z","damaged_quantity":0,"held_quantity":0,"incoming_quantity":12,"inventory_item_id":"invi_01K0P7W6A4N9F3J2T8Q5R1C6XM","inventory_level_claim_revision":0,"inventory_level_id":"invl_01K0P7W6A4N9F3J2T8Q5R1C7YP","inventory_level_physical_revision":1,"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6YN","on_hand_quantity":0,"quality_control_quantity":0,"quarantined_quantity":0,"safety_stock_quantity":0,"shortage_quantity":0,"unavailable_on_hand_quantity":0,"updated_at":"2026-07-21T14:18:00Z","version":1}]},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/InventoryTransferResultResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryTransferConflictErrorEnvelope"}}},"description":"State conflict. An unavailable action includes the transfer's current status, version, and supported actions.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Transition inventory transfer","tags":["inventory"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/invoice-payment-terms":{"get":{"description":"Returns a paginated list of invoice payment terms for the authenticated merchant.","operationId":"listInvoicePaymentTerms","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by payment term status.","in":"query","name":"status","required":false,"schema":{"enum":["active","archived"],"type":"string","x-enum-descriptions":["Active.","Archived."],"x-flint-enum":"open"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search across invoice payment term ID, external reference ID, and name.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePaymentTermListResponse"}}},"description":"A page of invoice payment terms.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List invoice payment terms","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.read","commerce.invoices.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Create invoice payment term for the authenticated merchant.","operationId":"createInvoicePaymentTerm","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoicePaymentTermRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePaymentTermResponse"}}},"description":"The invoice payment term.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment term not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create invoice payment term","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/invoice-payment-terms/{invoice_payment_term_id}":{"delete":{"description":"Retires an invoice payment term by setting its status to archived. A default payment term cannot be retired.","operationId":"deleteInvoicePaymentTerm","parameters":[{"description":"Flint invoice payment term ID.","in":"path","name":"invoice_payment_term_id","required":true,"schema":{"type":"string"}},{"description":"Optional version last read by the caller.","in":"query","name":"expected_version","required":false,"schema":{"format":"uint32","minimum":1,"type":"integer"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePaymentTermResponse"}}},"description":"The retired invoice payment term.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid expected version.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment term not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The payment term changed or is still used as a default.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Retire invoice payment term","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Returns one invoice payment term for the authenticated merchant.","operationId":"getInvoicePaymentTerm","parameters":[{"description":"Flint invoice payment term ID.","in":"path","name":"invoice_payment_term_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePaymentTermResponse"}}},"description":"The invoice payment term.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment term not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get invoice payment term","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.read","commerce.invoices.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Update invoice payment term for the authenticated merchant.","operationId":"updateInvoicePaymentTerm","parameters":[{"description":"Flint invoice payment term ID.","in":"path","name":"invoice_payment_term_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInvoicePaymentTermRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePaymentTermResponse"}}},"description":"The invoice payment term.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment term not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update invoice payment term","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/invoices":{"get":{"description":"Returns a paginated list of invoices for the authenticated merchant.","operationId":"listInvoices","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by invoice status. Repeat the parameter or pass comma-separated values to match multiple statuses.","explode":true,"in":"query","name":"status","required":false,"schema":{"items":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"Filter by Flint customer ID.","in":"query","name":"customer_id","required":false,"schema":{"type":"string"}},{"description":"Filter by Flint order ID.","in":"query","name":"order_id","required":false,"schema":{"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"RFC3339 lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 lower bound for due_at.","in":"query","name":"due_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for due_at.","in":"query","name":"due_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Filter by whether the invoice is overdue.","in":"query","name":"is_overdue","required":false,"schema":{"type":"boolean"}},{"description":"Filter by whether the invoice has a remaining amount due.","in":"query","name":"has_amount_due","required":false,"schema":{"type":"boolean"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["created_at","updated_at","due_at","invoice_number","outstanding_money"],"type":"string","x-enum-descriptions":["Created at.","Updated at.","Due at.","Invoice number.","Outstanding money."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"Search across invoice_id, invoice_number, external_reference_id, recipient_email, reference, and the customer name and email on the invoice.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"cc_emails":["owner@example.com"],"collection_block_status":"","collection_mode":"buyer_initiated","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer_id":"cus_01J00000000000000000000000","delivery_mode":"email","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1,"written_off_money":{"amount":0,"currency":"USD"}}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/InvoiceListResponse"}}},"description":"A page of invoices.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List invoices","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_BOOLEAN","INVALID_REQUEST","INVALID_STATUS","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.read","commerce.invoices.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates an invoice draft. Provide exactly one source: order_id for an order-backed draft, or quick_pay for a hidden backing-order draft.","operationId":"createInvoice","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"collection":{"mode":"buyer_initiated","payment_policy":{"enabled_payment_options":["card","ach_debit"]}},"memo":"Payment due within 10 days.","payment_due":{"due_at":"2026-03-31T23:59:59Z","type":"absolute"},"quick_pay":{"customer_id":"cus_01J00000000000000000000000","line_items":[{"name":"Consulting session","quantity":1,"unit_price_money":{"amount":15000,"currency":"USD"}}]},"recipient_email":"buyer@example.com","reference":"PO-1042"},"schema":{"allOf":[{"$ref":"#/components/schemas/CreateInvoiceRequest"}],"oneOf":[{"required":["order_id"],"type":"object"},{"required":["quick_pay"],"type":"object"}]}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"cc_emails":["owner@example.com"],"collection_block_status":"","collection_mode":"buyer_initiated","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer_id":"cus_01J00000000000000000000000","delivery_mode":"email","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1,"written_off_money":{"amount":0,"currency":"USD"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/InvoiceResponse"}}},"description":"The created invoice draft.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create invoice draft","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","AUTOMATIC_TAX_COMPONENTS_FORBIDDEN","AUTOMATIC_TAX_EXEMPTION_UNSUPPORTED","AUTOMATIC_TAX_MULTIPLE_DESTINATIONS","AUTOMATIC_TAX_MULTIPLE_ORIGINS","AUTOMATIC_TAX_POST_TAX_DISCOUNT_UNSUPPORTED","BUNDLE_NOT_SELLABLE","CATALOG_INVENTORY_RELATIONSHIP_INVALID","CATALOG_LINE_ITEM_CURRENCY_CHANGED","CATALOG_LINE_ITEM_FIELDS_READ_ONLY","CATALOG_LINE_ITEM_SOURCE_CHANGED","CHECKOUT_TAX_CALCULATION_LIMIT_REACHED","CREATE_ORDER_LINE_ITEM_DISCOUNT_UNSUPPORTED","CURRENCY_MISMATCH","DISCOUNT_AMOUNT_INVALID","DUPLICATE_ORDER_CHARGE_ID","DUPLICATE_TAX_COMPONENT","EXTERNAL_IMAGE_NOT_ALLOWED","EXTERNAL_TAX_COMPONENTS_REQUIRED","FIELD_REQUIRED","FLAT_TAX_SCOPE_INVALID","FULFILLMENT_BUNDLE_UNSUPPORTED","FULFILLMENT_CONFIGURATION_ACTION_REQUIRED","FULFILLMENT_PROFILE_REVISION_UNUSABLE","FULFILLMENT_REQUIREMENT_REQUIRED","IMAGE_ASSET_NOT_ATTACHABLE","IMAGE_ASSET_NOT_FOUND","IMAGE_URL_INVALID","IMAGE_URL_MUST_BE_CANONICAL","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_CURRENCY","INVALID_DISCOUNT","INVALID_DISCOUNT_CLASS","INVALID_DISCOUNT_SCOPE","INVALID_FIELD_TYPE","INVALID_FULFILLMENT_REQUIREMENT","INVALID_ID","INVALID_IMAGE_ALT","INVALID_LINE_ITEMS","INVALID_METADATA_KEY","INVALID_REQUEST","INVALID_TAX_CALCULATION_TYPE","INVALID_TAX_CATEGORY","INVALID_TAX_JURISDICTION","INVALID_TAX_MODE","INVALID_TAX_PERCENTAGE","INVALID_TAX_PRICE_MODE","INVALID_TAX_TYPE","INVALID_TIP","INVALID_TIP_AMOUNT","INVALID_TIP_PERCENT","INVALID_TOTALS","INVENTORY_DEMAND_DUPLICATE","INVENTORY_DEMAND_INVALID","INVENTORY_ROUTING_SOURCE_REQUIRED","LINE_ITEM_INVALID_QUANTITY","LINE_ITEM_NAME_REQUIRED","LINE_ITEM_NAME_TOO_LONG","LINE_ITEM_NEGATIVE_PRICE","LINE_ITEM_PRICE_REQUIRED","LINE_ITEM_QUANTITY_TOO_LARGE","LINE_ITEM_SOURCE_CONFLICT","LINE_ITEM_UNIT_PRICE_REQUIRED","METADATA_KEY_TOO_LONG","METADATA_TOO_LARGE","METADATA_TOO_MANY_KEYS","METADATA_VALUE_TOO_LONG","MISSING_LINE_ITEMS","MODIFIER_CURRENCY_MISMATCH","MODIFIER_DUPLICATE_SELECTION","MODIFIER_GROUP_REQUIRED","MODIFIER_QUANTITY_INVALID","MODIFIER_SELECTION_LIMIT_EXCEEDED","MODIFIER_SOURCE_UNSUPPORTED","MODIFIER_TEXT_INVALID","MODIFIER_UNAVAILABLE","NOTE_TOO_LONG","NO_DISCOUNTABLE_BALANCE","NULL_NOT_ALLOWED","ORDER_CHARGE_NOT_FOUND","ORDER_DISCOUNT_NO_CHARGE_IDS","ORDER_DISCOUNT_NO_LINE_ITEM_IDS","ORDER_LINE_ITEM_TAX_INPUT_REQUIRED","ORDER_TAX_CALCULATION_FAILED","ORDER_TAX_RATE_UNAVAILABLE","ORDER_TAX_UNSUPPORTED_COUNTRY","PRODUCT_LINE_ITEM_SOURCE_UNSUPPORTED","PROMOTION_CONFLICT","PROMOTION_DECLINED","PROMOTION_ID_REQUIRED","PROMOTION_NOT_REDEEMABLE","PROMOTION_NO_ACTIVE_CODES","RATE_LIMIT_EXCEEDED","RESERVED_METADATA_KEY","RESOURCE_NOT_FOUND","SERVICE_CHARGE_DISCOUNT_NO_LINE_ITEM_IDS","SERVICE_CHARGE_DISCOUNT_REQUIRES_CHARGE_IDS","SERVICE_CHARGE_DISCOUNT_SCOPE_INVALID","TAX_CALCULATION_REQUIRED","TAX_MODE_MISMATCH","TIP_CURRENCY_MISMATCH","TIP_LIMIT_EXCEEDED","TOO_MANY_LINE_ITEMS","UNKNOWN_FIELD","UNSUPPORTED_CURRENCY","VARIANT_NOT_SELLABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/invoices/{invoice_id}":{"get":{"description":"Returns a single invoice by ID.","operationId":"getInvoice","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: customer, order. Expansion requires commerce.invoices.read plus the read scope for each expanded resource. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=customer\u0026expand=order, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["customer","order"],"type":"string","x-enum-descriptions":["Customer.","Order."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Invoice","value":{"data":{"cc_emails":["owner@example.com"],"collection_block_status":"","collection_mode":"buyer_initiated","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer_id":"cus_01J00000000000000000000000","delivery_mode":"email","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1,"written_off_money":{"amount":0,"currency":"USD"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Invoice with expanded relationships","value":{"data":{"cc_emails":["owner@example.com"],"collection_block_status":"","collection_mode":"buyer_initiated","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer":{"created_at":"2026-03-20T15:03:00Z","customer_id":"cus_01J00000000000000000000000","email":"buyer@example.com","name":"Avery Buyer","updated_at":"2026-03-21T15:04:05Z"},"customer_id":"cus_01J00000000000000000000000","delivery_mode":"email","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order":{"created_at":"2026-03-21T15:03:00Z","customer_id":"cus_01J00000000000000000000000","fulfillment_status":"not_fulfilled","order_id":"ord_01J00000000000000000000000","order_number":"1001","payment_status":"","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":15000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","updated_at":"2026-03-21T15:04:05Z"},"order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1,"written_off_money":{"amount":0,"currency":"USD"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/InvoiceResponse"}}},"description":"The requested invoice.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"examples":{"invalid_expand":{"summary":"Unsupported expand path","value":{"error":{"code":"INVALID_EXPAND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Unknown expand path \"card\" for GET /v1/invoices/{invoice_id}. Supported values: customer, order.","param":"expand","remediation":{"next_steps":"Fix or remove the requested expand path; use only supported values documented for the route.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}},"validation":{"summary":"Validation error","value":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get invoice","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_EXPAND","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.read","commerce.invoices.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Updates mutable fields on a draft invoice. Sent invoices are immutable except for delivery-related actions.","operationId":"updateInvoice","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"cc_emails":["owner@example.com"],"memo":"Updated delivery instructions.","recipient_email":"accounts-payable@example.com"},"schema":{"$ref":"#/components/schemas/UpdateInvoiceRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"cc_emails":["owner@example.com"],"collection_block_status":"","collection_mode":"buyer_initiated","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer_id":"cus_01J00000000000000000000000","delivery_mode":"email","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1,"written_off_money":{"amount":0,"currency":"USD"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/InvoiceResponse"}}},"description":"The updated invoice draft.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update invoice draft","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/invoices/{invoice_id}/checkout-session":{"post":{"description":"Returns the current open invoice checkout session and aligned card attempt when they still match the invoice balance and collection run. A newly created session and attempt share the fixed expiration of the active invoice public-link generation. Unexpired sessions are reused regardless of remaining lifetime; active payment work returns a resolving conflict instead of creating competing collection.","operationId":"getOrCreateInvoiceCheckoutSession","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"checkout_session":{"checkout_session_id":"cs_01J00000000000000000000000","delivery_method_ids":null,"delivery_selection_required":false,"expires_at":"2026-03-21T16:05:00Z","invoice_id":"inv_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","problems":[],"recovery_mode":false,"status":"open","surface":"","url":"https://checkout.withflintpay.com/cs/cs_01J00000000000000000000000"},"hosted_checkout":{"checkout_auth_token":"csauth_example","url":"https://checkout.withflintpay.com/cs/cs_01J00000000000000000000000"},"invoice":{"cc_emails":["owner@example.com"],"collection_block_status":"","collection_mode":"buyer_initiated","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer_id":"cus_01J00000000000000000000000","delivery_mode":"email","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1,"written_off_money":{"amount":0,"currency":"USD"}},"invoice_payment_attempt":{"checkout_session_id":"cs_01J00000000000000000000000","expected_amount_money":{"amount":15000,"currency":"USD"},"invoice_id":"inv_01J00000000000000000000000","invoice_payment_attempt_id":"invpa_01J00000000000000000000000","rail":"card","started_at":"2026-03-21T15:05:00Z","status":"open"},"reused_existing":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/InvoiceCheckoutSessionResponse"}}},"description":"The existing aligned invoice checkout collection.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"201":{"content":{"application/json":{"example":{"data":{"checkout_session":{"checkout_session_id":"cs_01J00000000000000000000000","delivery_method_ids":null,"delivery_selection_required":false,"expires_at":"2026-03-21T16:05:00Z","invoice_id":"inv_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","problems":[],"recovery_mode":false,"status":"open","surface":"","url":"https://checkout.withflintpay.com/cs/cs_01J00000000000000000000000"},"hosted_checkout":{"checkout_auth_token":"csauth_example","url":"https://checkout.withflintpay.com/cs/cs_01J00000000000000000000000"},"invoice":{"cc_emails":["owner@example.com"],"collection_block_status":"","collection_mode":"buyer_initiated","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer_id":"cus_01J00000000000000000000000","delivery_mode":"email","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1,"written_off_money":{"amount":0,"currency":"USD"}},"invoice_payment_attempt":{"checkout_session_id":"cs_01J00000000000000000000000","expected_amount_money":{"amount":15000,"currency":"USD"},"invoice_id":"inv_01J00000000000000000000000","invoice_payment_attempt_id":"invpa_01J00000000000000000000000","rail":"card","started_at":"2026-03-21T15:05:00Z","status":"open"},"reused_existing":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/InvoiceCheckoutSessionResponse"}}},"description":"A newly created aligned invoice checkout collection.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get or create invoice checkout collection","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","AUTOMATIC_TAX_PARTIAL_PAYMENT_UNSUPPORTED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","INVOICE_TAX_SNAPSHOT_MISSING","INVOICE_TAX_SNAPSHOT_STALE","ORDER_TAX_NOT_READY","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/invoices/{invoice_id}/collect":{"post":{"description":"Charges the invoice's saved payment method or the supplied saved payment method. This command requires a caller-chosen Idempotency-Key that is reused for retries of the same collection request.","operationId":"collectInvoice","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Caller-chosen idempotency key. Reuse it for retries of the same collection request.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectInvoiceRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectInvoiceResponse"}}},"description":"The invoice and payment attempt.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"402":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Collect invoice","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","INVOICE_TAX_SNAPSHOT_MISSING","INVOICE_TAX_SNAPSHOT_STALE","ORDER_TAX_NOT_READY","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/invoices/{invoice_id}/delivery-attempts":{"get":{"description":"Returns email delivery attempts for send and reminder actions.","operationId":"listInvoiceDeliveryAttempts","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"channel":"email","created_at":"2026-03-21T15:04:05Z","delivery_type":"send","invoice_delivery_attempt_id":"indel_01J00000000000000000000000","sent_at":"2026-03-21T15:04:06Z","status":"sent","to_email":"buyer@example.com"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/InvoiceDeliveryAttemptListResponse"}}},"description":"A page of invoice delivery attempts.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List invoice delivery attempts","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.read","commerce.invoices.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/invoices/{invoice_id}/events":{"get":{"description":"Returns the audit timeline for an invoice.","operationId":"listInvoiceEvents","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"actor_type":"merchant","description":"Invoice sent","event_type":"sent","invoice_event_id":"inevt_01J00000000000000000000000","occurred_at":"2026-03-21T15:04:05Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/InvoiceEventListResponse"}}},"description":"A page of invoice events.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List invoice events","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.read","commerce.invoices.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/invoices/{invoice_id}/issue":{"post":{"description":"Issues the invoice, creates the buyer-access link, and uses the selected delivery mode. Safe to retry with the same Idempotency-Key.","operationId":"issueInvoice","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"delivery_mode":"email"},"schema":{"$ref":"#/components/schemas/IssueInvoiceRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"delivery_attempt":{"channel":"email","created_at":"2026-03-21T15:04:05Z","delivery_type":"send","invoice_delivery_attempt_id":"indel_01J00000000000000000000000","sent_at":"2026-03-21T15:04:06Z","status":"sent","to_email":"buyer@example.com"},"invoice":{"cc_emails":["owner@example.com"],"collection_block_status":"","collection_mode":"buyer_initiated","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer_id":"cus_01J00000000000000000000000","delivery_mode":"email","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1,"written_off_money":{"amount":0,"currency":"USD"}},"public_url":"https://checkout.withflintpay.com/i/ivat_01J0000000000000000000000#invoice_token=ivt_example"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/IssueInvoiceResponse"}}},"description":"The issued invoice and initial delivery outcome.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Issue invoice","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","AUTOMATIC_TAX_INVOICE_INSTALLMENTS_UNSUPPORTED","AUTOMATIC_TAX_PARTIAL_PAYMENT_UNSUPPORTED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_EXPECTED_VERSION","INVALID_REQUEST","INVOICE_DRAFT_CHANGED","ORDER_TAX_NOT_READY","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/invoices/{invoice_id}/late-fees":{"post":{"description":"Assesses the frozen late fee policy once per invoice or overdue schedule entry. The issued document remains unchanged.","operationId":"assessInvoiceLateFee","parameters":[{"description":"Invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{},"schema":{"$ref":"#/components/schemas/AssessInvoiceLateFeeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"cc_emails":["owner@example.com"],"collection_block_status":"","collection_mode":"buyer_initiated","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer_id":"cus_01J00000000000000000000000","delivery_mode":"email","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1,"written_off_money":{"amount":0,"currency":"USD"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/InvoiceResponse"}}},"description":"Updated invoice.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice or late fee not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice or fee is not eligible.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Assess an invoice late fee","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_INVOICE_LATE_FEE_AMOUNT","INVALID_INVOICE_LATE_FEE_SCHEDULE","INVALID_REQUEST","INVOICE_LATE_FEE_NOT_COLLECTIBLE","INVOICE_LATE_FEE_NOT_DUE","INVOICE_LATE_FEE_NOT_FOUND","INVOICE_LATE_FEE_POLICY_REQUIRED","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/invoices/{invoice_id}/late-fees/{invoice_late_fee_id}/waive":{"post":{"description":"Waives the unpaid remainder of an assessed late fee. Collected money is not refunded. The reason is visible only to the merchant.","operationId":"waiveInvoiceLateFee","parameters":[{"description":"Invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Invoice late fee ID.","in":"path","name":"invoice_late_fee_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"reason":"Courtesy waiver"},"schema":{"$ref":"#/components/schemas/WaiveInvoiceLateFeeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"cc_emails":["owner@example.com"],"collection_block_status":"","collection_mode":"buyer_initiated","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer_id":"cus_01J00000000000000000000000","delivery_mode":"email","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1,"written_off_money":{"amount":0,"currency":"USD"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/InvoiceResponse"}}},"description":"Updated invoice.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice or late fee not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice or fee is not eligible.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Waive an unpaid invoice late fee","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_INVOICE_LATE_FEE_REASON","INVALID_REQUEST","INVOICE_LATE_FEE_NOT_COLLECTIBLE","INVOICE_LATE_FEE_NOT_FOUND","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/invoices/{invoice_id}/manual-payments":{"post":{"description":"Applies an offline/manual payment to an issued invoice. Recording is rejected with INVOICE_PAYMENT_RESOLVING while an online payment is still resolving; an idle open checkout does not block. A payment that clears the balance invalidates the open checkout session. Safe to retry with the same Idempotency-Key.","operationId":"recordManualInvoicePayment","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"amount_money":{"amount":5000,"currency":"USD"},"external_reference_id":"manual-payment-1024","note":"Paid by check #1024","received_at":"2026-03-22T10:00:00Z"},"schema":{"$ref":"#/components/schemas/InvoiceManualPaymentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"cc_emails":["owner@example.com"],"collection_block_status":"","collection_mode":"buyer_initiated","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer_id":"cus_01J00000000000000000000000","delivery_mode":"email","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1,"written_off_money":{"amount":0,"currency":"USD"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/InvoiceResponse"}}},"description":"The updated invoice after recording the payment.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Record manual invoice payment","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","AUTOMATIC_TAX_PARTIAL_PAYMENT_UNSUPPORTED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_EXPECTED_VERSION","INVALID_REQUEST","INVOICE_DRAFT_CHANGED","INVOICE_TAX_SNAPSHOT_MISSING","INVOICE_TAX_SNAPSHOT_STALE","ORDER_TAX_NOT_READY","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/invoices/{invoice_id}/manual-payments/reverse":{"post":{"description":"Reverses previously applied manual/offline payment amount from an invoice. Safe to retry with the same Idempotency-Key.","operationId":"reverseManualInvoicePayment","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"amount_money":{"amount":5000,"currency":"USD"},"external_reference_id":"manual-payment-1024","note":"Paid by check #1024","received_at":"2026-03-22T10:00:00Z"},"schema":{"$ref":"#/components/schemas/InvoiceManualPaymentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"cc_emails":["owner@example.com"],"collection_block_status":"","collection_mode":"buyer_initiated","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer_id":"cus_01J00000000000000000000000","delivery_mode":"email","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1,"written_off_money":{"amount":0,"currency":"USD"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/InvoiceResponse"}}},"description":"The updated invoice after reversing the payment.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Reverse manual invoice payment","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_EXPECTED_VERSION","INVALID_REQUEST","INVOICE_DRAFT_CHANGED","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/invoices/{invoice_id}/mark-uncollectible":{"post":{"description":"Closes the outstanding balance as a write-off and releases the order's invoice collection authority. Safe to retry with the same Idempotency-Key.","operationId":"markInvoiceUncollectible","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceVersionRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"example":{"data":{"cc_emails":["owner@example.com"],"collection_block_status":"","collection_mode":"buyer_initiated","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer_id":"cus_01J00000000000000000000000","delivery_mode":"email","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1,"written_off_money":{"amount":0,"currency":"USD"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/InvoiceResponse"}}},"description":"The uncollectible invoice.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Mark invoice uncollectible","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_EXPECTED_VERSION","INVALID_REQUEST","INVOICE_DRAFT_CHANGED","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/invoices/{invoice_id}/pause-reminders":{"post":{"description":"Stops the automatic reminder cadence on a collectible invoice and sets reminders_paused_at. Manual send-reminder calls still work, and invoice.overdue and invoice.late_fee_due still fire.","operationId":"pauseInvoiceReminders","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceVersionRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceResponse"}}},"description":"The updated invoice.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice state conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Pause invoice reminders","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_EXPECTED_VERSION","INVALID_REQUEST","INVOICE_DRAFT_CHANGED","INVOICE_NOT_COLLECTIBLE","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/invoices/{invoice_id}/payment-attempts":{"get":{"description":"Lists card and ACH collection attempts for an invoice in reverse chronological order.","operationId":"listInvoicePaymentAttempts","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Return the attempt created with this caller-chosen idempotency key.","in":"query","name":"idempotency_key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePaymentAttemptListResponse"}}},"description":"A page of invoice payment attempts.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List invoice payment attempts","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.read","commerce.invoices.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/invoices/{invoice_id}/payment-attempts/{invoice_payment_attempt_id}":{"get":{"description":"Returns one card or ACH collection attempt for the invoice.","operationId":"getInvoicePaymentAttempt","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Flint invoice payment attempt ID.","in":"path","name":"invoice_payment_attempt_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePaymentAttemptResponse"}}},"description":"The invoice payment attempt.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice payment attempt not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get invoice payment attempt","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.read","commerce.invoices.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/invoices/{invoice_id}/payment-attempts/{invoice_payment_attempt_id}/cancel":{"post":{"description":"Cancels an active invoice payment attempt and its payment intent. Safe to retry with the same Idempotency-Key.","operationId":"cancelInvoicePaymentAttempt","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Flint invoice payment attempt ID.","in":"path","name":"invoice_payment_attempt_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePaymentAttemptResponse"}}},"description":"The canceled invoice payment attempt.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice payment attempt not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Cancel invoice payment attempt","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/invoices/{invoice_id}/pdf":{"get":{"description":"Downloads the merchant-authenticated PDF artifact generated from the invoice snapshot.","operationId":"getInvoicePDF","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/pdf":{}},"description":"A PDF document.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Download invoice PDF","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.read","commerce.invoices.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/invoices/{invoice_id}/regenerate-public-link":{"post":{"description":"Revokes the current buyer-access link and all checkout credentials derived from it, then returns a new public_url. The current checkout session and its payment lineage are preserved. Safe to retry with the same Idempotency-Key.","operationId":"regenerateInvoicePublicLink","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceVersionRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"example":{"data":{"invoice":{"cc_emails":["owner@example.com"],"collection_block_status":"","collection_mode":"buyer_initiated","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer_id":"cus_01J00000000000000000000000","delivery_mode":"email","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1,"written_off_money":{"amount":0,"currency":"USD"}},"public_url":"https://checkout.withflintpay.com/i/ivat_01J0000000000000000000001#invoice_token=ivt_example_new"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/RegenerateInvoiceLinkResponse"}}},"description":"The invoice and the newly active public URL.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Regenerate invoice public link","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_EXPECTED_VERSION","INVALID_REQUEST","INVOICE_DRAFT_CHANGED","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/invoices/{invoice_id}/resume-reminders":{"post":{"description":"Clears reminders_paused_at so the invoice resumes its reminder cadence. Reminder times that passed while it was paused do not fire retroactively.","operationId":"resumeInvoiceReminders","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceVersionRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceResponse"}}},"description":"The updated invoice.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice state conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Resume invoice reminders","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_EXPECTED_VERSION","INVALID_REQUEST","INVOICE_DRAFT_CHANGED","INVOICE_NOT_COLLECTIBLE","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/invoices/{invoice_id}/send-reminder":{"post":{"description":"Attempts a reminder email for an already issued collectible invoice. Safe to retry with the same Idempotency-Key.","operationId":"sendInvoiceReminder","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"delivery_attempt":{"channel":"email","created_at":"2026-03-21T15:04:05Z","delivery_type":"send","invoice_delivery_attempt_id":"indel_01J00000000000000000000000","sent_at":"2026-03-21T15:04:06Z","status":"sent","to_email":"buyer@example.com"},"invoice":{"cc_emails":["owner@example.com"],"collection_block_status":"","collection_mode":"buyer_initiated","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer_id":"cus_01J00000000000000000000000","delivery_mode":"email","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1,"written_off_money":{"amount":0,"currency":"USD"}},"public_url":"https://checkout.withflintpay.com/i/ivat_01J0000000000000000000000#invoice_token=ivt_example"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/IssueInvoiceResponse"}}},"description":"The invoice and reminder delivery outcome.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Send invoice reminder","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/invoices/{invoice_id}/void":{"post":{"description":"Voids an unpaid invoice so the associated order can be edited or collected again. An invoice with an issued credit note against it cannot be voided until that credit note is voided.","operationId":"voidInvoice","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceVersionRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"example":{"data":{"cc_emails":["owner@example.com"],"collection_block_status":"","collection_mode":"buyer_initiated","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer_id":"cus_01J00000000000000000000000","delivery_mode":"email","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1,"written_off_money":{"amount":0,"currency":"USD"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/InvoiceResponse"}}},"description":"The voided invoice.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Void invoice","tags":["invoices"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_EXPECTED_VERSION","INVALID_REQUEST","INVOICE_DRAFT_CHANGED","INVOICE_HAS_ISSUED_CREDIT_NOTE","INVOICE_NOT_VOIDABLE","INVOICE_PAYMENT_RESOLVING","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.invoices.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.invoices.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/locations":{"get":{"description":"List Locations. Filtering by inventory_allocation_status requires commerce.inventory.read; the inventory block is omitted entirely when the caller lacks inventory read authority.","operationId":"listLocations","parameters":[{"description":"Number of resources to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Stable cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by Location status. Defaults to active.","in":"query","name":"status","required":false,"schema":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"}},{"description":"Filter by inventory allocation status. Requires commerce.inventory.read.","in":"query","name":"inventory_allocation_status","required":false,"schema":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search Location ID, external reference ID, or name.","in":"query","name":"query","required":false,"schema":{"maxLength":255,"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"address":{"city":"Brooklyn","country":"US","line1":"120 Kent Avenue","postal_code":"11249","state":"NY"},"coordinate":{"latitude":40.7213,"longitude":-73.9615},"coordinate_source":"merchant_supplied","created_at":"2026-05-02T11:04:00Z","geography_revision":2,"inventory":{"allocation_status":"active","created_at":"2026-05-02T11:04:00Z","inventory_revision":1,"updated_at":"2026-05-02T11:04:00Z"},"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","metadata":{"region":"northeast"},"name":"Brooklyn warehouse","status":"active","timezone":"America/New_York","updated_at":"2026-07-14T09:12:00Z","validation_status":"not_validated","version":4}],"next_page_token":"","request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/LocationListResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List locations","tags":["locations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["merchants.locations.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["merchants.locations.read","merchants.locations.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Create a Location. Including the inventory block also requires commerce.inventory_locations.write.","operationId":"createLocation","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"address":{"city":"Brooklyn","country":"US","line1":"120 Kent Avenue","postal_code":"11249","state":"NY"},"inventory":{"allocation_status":"active"},"name":"Brooklyn warehouse","status":"active","timezone":"America/New_York"},"schema":{"$ref":"#/components/schemas/CreateLocationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"address":{"city":"Brooklyn","country":"US","line1":"120 Kent Avenue","postal_code":"11249","state":"NY"},"coordinate":{"latitude":40.7213,"longitude":-73.9615},"coordinate_source":"merchant_supplied","created_at":"2026-05-02T11:04:00Z","geography_revision":2,"inventory":{"allocation_status":"active","created_at":"2026-05-02T11:04:00Z","inventory_revision":1,"updated_at":"2026-05-02T11:04:00Z"},"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","metadata":{"region":"northeast"},"name":"Brooklyn warehouse","status":"active","timezone":"America/New_York","updated_at":"2026-07-14T09:12:00Z","validation_status":"not_validated","version":4},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/LocationResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create location","tags":["locations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["merchants.locations.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["merchants.locations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/locations/{location_id}":{"delete":{"description":"Retire a Location. Preserves the archived resource for direct reads.","operationId":"deleteLocation","parameters":[{"description":"Flint Location ID.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"Current resource version used as a concurrency fence.","in":"query","name":"expected_version","required":false,"schema":{"minimum":1,"type":"integer"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"address":{"city":"Brooklyn","country":"US","line1":"120 Kent Avenue","postal_code":"11249","state":"NY"},"coordinate":{"latitude":40.7213,"longitude":-73.9615},"coordinate_source":"merchant_supplied","created_at":"2026-05-02T11:04:00Z","geography_revision":2,"inventory":{"allocation_status":"active","created_at":"2026-05-02T11:04:00Z","inventory_revision":1,"updated_at":"2026-05-02T11:04:00Z"},"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","metadata":{"region":"northeast"},"name":"Brooklyn warehouse","status":"active","timezone":"America/New_York","updated_at":"2026-07-14T09:12:00Z","validation_status":"not_validated","version":4},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/LocationResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Retire location","tags":["locations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["merchants.locations.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["merchants.locations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Get location.","operationId":"getLocation","parameters":[{"description":"Flint Location ID.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"address":{"city":"Brooklyn","country":"US","line1":"120 Kent Avenue","postal_code":"11249","state":"NY"},"coordinate":{"latitude":40.7213,"longitude":-73.9615},"coordinate_source":"merchant_supplied","created_at":"2026-05-02T11:04:00Z","geography_revision":2,"inventory":{"allocation_status":"active","created_at":"2026-05-02T11:04:00Z","inventory_revision":1,"updated_at":"2026-05-02T11:04:00Z"},"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","metadata":{"region":"northeast"},"name":"Brooklyn warehouse","status":"active","timezone":"America/New_York","updated_at":"2026-07-14T09:12:00Z","validation_status":"not_validated","version":4},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/LocationResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get location","tags":["locations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["merchants.locations.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["merchants.locations.read","merchants.locations.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Update a Location's profile or availability. Accepts status active or inactive.","operationId":"updateLocation","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Flint Location ID.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"expected_version":4,"name":"Brooklyn warehouse (Kent Ave)"},"schema":{"$ref":"#/components/schemas/UpdateLocationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"address":{"city":"Brooklyn","country":"US","line1":"120 Kent Avenue","postal_code":"11249","state":"NY"},"coordinate":{"latitude":40.7213,"longitude":-73.9615},"coordinate_source":"merchant_supplied","created_at":"2026-05-02T11:04:00Z","geography_revision":2,"inventory":{"allocation_status":"active","created_at":"2026-05-02T11:04:00Z","inventory_revision":1,"updated_at":"2026-05-02T11:04:00Z"},"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","metadata":{"region":"northeast"},"name":"Brooklyn warehouse","status":"active","timezone":"America/New_York","updated_at":"2026-07-14T09:12:00Z","validation_status":"not_validated","version":4},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/LocationResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update location","tags":["locations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["merchants.locations.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["merchants.locations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/locations/{location_id}/geography":{"patch":{"description":"Publishes the location geography atomically. Supply the complete address and timezone; omitted coordinates are cleared. This PATCH does not merge nested address fields. Requires expected_geography_revision, independently of the location version used for metadata edits.","operationId":"publishLocationGeography","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Flint Location ID.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"address":{"city":"Brooklyn","country":"US","line1":"120 Kent Avenue","line2":"Suite 300","postal_code":"11249","state":"NY"},"coordinate":{"latitude":40.7213,"longitude":-73.9615},"coordinate_source":"merchant","expected_geography_revision":2,"timezone":"America/New_York"},"schema":{"$ref":"#/components/schemas/PublishLocationGeographyRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"address":{"city":"Brooklyn","country":"US","line1":"120 Kent Avenue","postal_code":"11249","state":"NY"},"coordinate":{"latitude":40.7213,"longitude":-73.9615},"coordinate_source":"merchant_supplied","created_at":"2026-05-02T11:04:00Z","geography_revision":2,"inventory":{"allocation_status":"active","created_at":"2026-05-02T11:04:00Z","inventory_revision":1,"updated_at":"2026-05-02T11:04:00Z"},"location_id":"loc_01K0P7W6A4N9F3J2T8Q5R1C6XM","metadata":{"region":"northeast"},"name":"Brooklyn warehouse","status":"active","timezone":"America/New_York","updated_at":"2026-07-14T09:12:00Z","validation_status":"not_validated","version":4},"request_id":"req_01K0P7W6A4N9F3J2T8Q5R1C6XM"},"schema":{"$ref":"#/components/schemas/LocationResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Publish location geography","tags":["locations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["merchants.locations.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["merchants.locations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/locations/{location_id}/inventory":{"patch":{"description":"Enable or disable inventory allocation at a Location. Omit expected_inventory_revision when enabling inventory for the first time; otherwise send the current inventory_revision.","operationId":"updateLocationInventory","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Flint Location ID.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"allocation_status":"inactive","expected_inventory_revision":2},"schema":{"$ref":"#/components/schemas/UpdateLocationInventoryRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"allocation_status":"active","created_at":"2026-08-02T16:00:00Z","inventory_revision":0,"updated_at":"2026-08-02T16:00:00Z"},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/LocationInventoryResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update location inventory","tags":["locations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.inventory_locations.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.inventory_locations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/me":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns a single customer by ID.","operationId":"getMe","parameters":[{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Customer","value":{"data":{"billing_address":{"city":"New York","country":"US","line1":"123 Main St","postal_code":"10001","state":"NY"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","email":"jane@example.com","group_id":"vip","is_verified":true,"merchant_id":"mer_123","metadata":{"crm_id":"crm_123"},"name":"Jane Doe","phone":"+14155552671","tax_exempt":true,"tax_identity":null,"updated_at":"2026-03-17T14:30:00Z","version":0},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Customer with expanded default payment method","value":{"data":{"billing_address":{"city":"New York","country":"US","line1":"123 Main St","postal_code":"10001","state":"NY"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","default_payment_method":{"card":{"brand":"visa","exp_month":12,"exp_year":2030,"last4":"4242"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","payment_method_id":"pm_123","status":"active","type":"card","updated_at":"2026-03-17T14:30:00Z"},"default_payment_method_id":"pm_123","email":"jane@example.com","group_id":"vip","is_verified":true,"merchant_id":"mer_123","metadata":{"crm_id":"crm_123"},"name":"Jane Doe","phone":"+14155552671","receivables":{"balances":[{"currency":"USD","outstanding_money":{"amount":12500,"currency":"USD"},"overdue_money":{"amount":2500,"currency":"USD"}}],"observed_at":"2026-03-17T14:30:00Z"},"tax_exempt":true,"tax_identity":null,"updated_at":"2026-03-17T14:30:00Z","version":0},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/CustomerResponse"}}},"description":"The requested customer.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"customer not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Get the current buyer profile","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"},"patch":{"description":"Uses the customer identity fixed by the customer session. Updates the current buyer's name or phone. Manage billing and shipping addresses through /v1/me/addresses.","operationId":"updateMe","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"name":"Ada Lovelace","phone":"+14155550123"},"schema":{"$ref":"#/components/schemas/UpdateMeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"billing_address":{"city":"New York","country":"US","line1":"123 Main St","postal_code":"10001","state":"NY"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","email":"jane@example.com","group_id":"vip","is_verified":true,"merchant_id":"mer_123","metadata":{"crm_id":"crm_123"},"name":"Jane Doe","phone":"+14155552671","tax_exempt":true,"tax_identity":null,"updated_at":"2026-03-17T14:30:00Z","version":0},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CustomerResponse"}}},"description":"The updated customer.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Update the current buyer profile","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-route-class":"write"}},"/v1/me/addresses":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Lists the customer's saved addresses with billing and shipping default flags.","operationId":"listMeAddresses","parameters":[{"description":"Number of addresses to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque token returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddressListResponse"}}},"description":"The customer's addresses.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer account resources are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"List the current buyer's addresses","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"},"post":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Creates a stable saved address. The first address becomes both the billing and shipping default. A saved default becomes the customer's effective address for the corresponding role.","operationId":"createMeAddress","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomerAddressRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddressResponse"}}},"description":"The created address.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer account resources are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Create an address for the current buyer","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"write"}},"/v1/me/addresses/{customer_address_id}":{"delete":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Deletes a saved address and moves any default designation to the newest remaining address.","operationId":"deleteMeAddress","parameters":[{"description":"Flint customer address ID.","in":"path","name":"customer_address_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionResponse"}}},"description":"The address was deleted.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer account resources are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Delete one of the current buyer's addresses","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"write"},"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns one saved address owned by the customer.","operationId":"getMeAddress","parameters":[{"description":"Flint customer address ID.","in":"path","name":"customer_address_id","required":true,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddressResponse"}}},"description":"The requested address.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer account resources are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Get one of the current buyer's addresses","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"},"patch":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Applies a sparse update to a saved address. Updating a default address also updates the customer's effective address for that role.","operationId":"updateMeAddress","parameters":[{"description":"Flint customer address ID.","in":"path","name":"customer_address_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCustomerAddressRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddressResponse"}}},"description":"The updated address.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer account resources are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Update one of the current buyer's addresses","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"write"}},"/v1/me/addresses/{customer_address_id}/set-default":{"post":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Sets the address as the billing default, shipping default, or both and makes it the customer's effective address for each selected role.","operationId":"setDefaultMeAddress","parameters":[{"description":"Flint customer address ID.","in":"path","name":"customer_address_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetDefaultCustomerAddressRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAddressResponse"}}},"description":"The default address.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer account resources are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Set a default address for the current buyer","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"write"}},"/v1/me/deletion-requests":{"post":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Creates or returns the pending tracked deletion request. Required commerce records are retained until the deletion workflow resolves their legal retention requirements.","operationId":"createMeDeletionRequest","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDeletionRequestResponse"}}},"description":"The tracked deletion request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer account resources are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Request deletion of the current buyer's account","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"sensitive_write"}},"/v1/me/deletion-requests/{customer_deletion_request_id}":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns the current status of a tracked deletion request.","operationId":"getMeDeletionRequest","parameters":[{"description":"Flint customer deletion request ID.","in":"path","name":"customer_deletion_request_id","required":true,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerDeletionRequestResponse"}}},"description":"The tracked deletion request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer account resources are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Get the current buyer's deletion request","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/me/email-change-requests":{"post":{"description":"Sends short-lived confirmation codes to the current and new email addresses. If the account has no current email, only the new address must be confirmed. The customer email does not change until confirmation succeeds.","operationId":"createMeEmailChangeRequest","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEmailChangeRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailChangeRequestResponse"}}},"description":"The pending email change request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer account resources are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Request an email change","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","CUSTOMER_EMAIL_ALREADY_USED","EMAIL_CHANGE_DELIVERY_FAILED","EMAIL_CHANGE_RATE_LIMITED","INSUFFICIENT_SCOPE","INVALID_CUSTOMER_ACCOUNT_REQUEST","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"sensitive_write"}},"/v1/me/email-change-requests/{email_change_request_id}/confirm":{"post":{"description":"Confirms possession of the current and new email addresses, then atomically updates the customer account in the selected merchant environment. Omit current_email_code only when current_email_confirmation_required is false.","operationId":"confirmMeEmailChangeRequest","parameters":[{"description":"Flint email change request ID.","in":"path","name":"email_change_request_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmEmailChangeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailChangeRequestResponse"}}},"description":"The confirmed email change request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Customer account resources are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Confirm an email change","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"sensitive_write"}},"/v1/me/fulfillments":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns fulfillments for operational queue and order-detail views. Results default to newest created first.","operationId":"listMeFulfillments","parameters":[{"description":"Filter by order ID.","in":"query","name":"order_id","required":false,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search across fulfillment_id and external_reference_id. Also matches an exact order number.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Filter by the projected value returned in Fulfillment.status. Fulfillments with request_status accepted project to status pending. Fulfillments with outcome.outcome_type no_show project to status failed. A fulfillment with active_hold projects to its public work status from before the hold.","in":"query","name":"status","required":false,"schema":{"enum":["pending","in_progress","ready","completed","canceled","failed","scheduled","preparing","picked","packed","dispatched"],"type":"string","x-enum-descriptions":["Pending.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Preparing.","Picked.","Packed.","Dispatched."],"x-flint-enum":"open"}},{"description":"Filter by fulfillment type.","in":"query","name":"type","required":false,"schema":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"}},{"description":"Filter by assigned Location ID.","in":"query","name":"location_id","required":false,"schema":{"type":"string"}},{"description":"Lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Lower bound for updated_at.","in":"query","name":"updated_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Upper bound for updated_at.","in":"query","name":"updated_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Sort direction for created_at. Defaults to desc.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Fulfillment list","value":{"data":[{"completed_at":"2026-05-13T14:30:00Z","created_at":"2026-05-13T09:45:00Z","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","line_items":[{"order_line_item_id":"li_123","quantity":1}],"metadata":{"source":"dispatch"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","request_status":"accepted","status":"completed","supported_actions":[],"type":"shipment","updated_at":"2026-05-13T14:30:00Z","version":4}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Fulfillment list with expanded orders","value":{"data":[{"completed_at":"2026-05-13T14:30:00Z","created_at":"2026-05-13T09:45:00Z","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","line_items":[{"order_line_item_id":"li_123","quantity":1}],"metadata":{"source":"dispatch"},"order":{"created_at":"2026-05-13T09:30:00Z","customer_id":"cus_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_status":"completed","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","order_number":"1001","payment_intent_ids":["pi_01ABCDEFGHIJKLMNOPQRSTUVWX"],"payment_status":"","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","updated_at":"2026-05-13T14:30:00Z"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","packages":[{"carrier":"ups","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"in_transit","supported_actions":null,"tracking_number":"1Z999AA10123456784","tracking_url":"https://track.example.com/1Z999AA10123456784","version":0}],"request_status":"accepted","shipments":[{"direction":"outbound","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","package_count":0,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"in_transit"}],"status":"completed","supported_actions":[],"type":"shipment","updated_at":"2026-05-13T14:30:00Z","version":4}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/FulfillmentListResponse"}}},"description":"Fulfillments for the order.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"List the current buyer's fulfillments","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/me/invoices":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns a paginated list of invoices for the authenticated merchant.","operationId":"listMeInvoices","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by invoice status. Repeat the parameter or pass comma-separated values to match multiple statuses.","explode":true,"in":"query","name":"status","required":false,"schema":{"items":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"Filter by Flint order ID.","in":"query","name":"order_id","required":false,"schema":{"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"RFC3339 lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 lower bound for due_at.","in":"query","name":"due_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for due_at.","in":"query","name":"due_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Filter by whether the invoice is overdue.","in":"query","name":"is_overdue","required":false,"schema":{"type":"boolean"}},{"description":"Filter by whether the invoice has a remaining amount due.","in":"query","name":"has_amount_due","required":false,"schema":{"type":"boolean"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["created_at","updated_at","due_at","invoice_number","outstanding_money"],"type":"string","x-enum-descriptions":["Created at.","Updated at.","Due at.","Invoice number.","Outstanding money."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"Search across invoice_id, invoice_number, external_reference_id, recipient_email, reference, and the customer name and email on the invoice.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"cc_emails":["owner@example.com"],"collection_block_status":"","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer_id":"cus_01J00000000000000000000000","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/BuyerInvoiceListResponse"}}},"description":"A page of invoices.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"List the current buyer's invoices","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_BOOLEAN","INVALID_REQUEST","INVALID_STATUS","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/me/invoices/{invoice_id}":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns a single invoice by ID.","operationId":"getMeInvoice","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":null,"examples":{"default":{"summary":"Invoice","value":{"data":{"cc_emails":["owner@example.com"],"collection_block_status":"","collection_mode":"buyer_initiated","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer_id":"cus_01J00000000000000000000000","delivery_mode":"email","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1,"written_off_money":{"amount":0,"currency":"USD"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Invoice with expanded relationships","value":{"data":{"cc_emails":["owner@example.com"],"collection_block_status":"","collection_mode":"buyer_initiated","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer":{"created_at":"2026-03-20T15:03:00Z","customer_id":"cus_01J00000000000000000000000","email":"buyer@example.com","name":"Avery Buyer","updated_at":"2026-03-21T15:04:05Z"},"customer_id":"cus_01J00000000000000000000000","delivery_mode":"email","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order":{"created_at":"2026-03-21T15:03:00Z","customer_id":"cus_01J00000000000000000000000","fulfillment_status":"not_fulfilled","order_id":"ord_01J00000000000000000000000","order_number":"1001","payment_status":"","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":15000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","updated_at":"2026-03-21T15:04:05Z"},"order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1,"written_off_money":{"amount":0,"currency":"USD"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/BuyerInvoiceResponse"}}},"description":"The requested invoice.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"examples":{"invalid_expand":{"summary":"Unsupported expand path","value":{"error":{"code":"INVALID_EXPAND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Unknown expand path \"card\" for GET /v1/invoices/{invoice_id}. Supported values: customer, order.","param":"expand","remediation":{"next_steps":"Fix or remove the requested expand path; use only supported values documented for the route.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}},"validation":{"summary":"Validation error","value":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]},{"InvoiceAccessTokenBearer":[]}],"summary":"Get one of the current buyer's invoices","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_EXPAND","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/me/invoices/{invoice_id}/checkout-session":{"post":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns the current open invoice checkout session and aligned card attempt when they still match the invoice balance and collection run. A newly created session and attempt share the fixed expiration of the active invoice public-link generation. Unexpired sessions are reused regardless of remaining lifetime; active payment work returns a resolving conflict instead of creating competing collection.","operationId":"createMeInvoiceCheckoutSession","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"checkout_session":{"checkout_session_id":"cs_01J00000000000000000000000","delivery_method_ids":null,"delivery_selection_required":false,"expires_at":"2026-03-21T16:05:00Z","invoice_id":"inv_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","problems":[],"recovery_mode":false,"status":"open","surface":"","url":"https://checkout.withflintpay.com/cs/cs_01J00000000000000000000000"},"hosted_checkout":{"checkout_auth_token":"csauth_example","url":"https://checkout.withflintpay.com/cs/cs_01J00000000000000000000000"},"invoice":{"cc_emails":["owner@example.com"],"collection_block_status":"","collection_mode":"buyer_initiated","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer_id":"cus_01J00000000000000000000000","delivery_mode":"email","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1,"written_off_money":{"amount":0,"currency":"USD"}},"invoice_payment_attempt":{"checkout_session_id":"cs_01J00000000000000000000000","expected_amount_money":{"amount":15000,"currency":"USD"},"invoice_id":"inv_01J00000000000000000000000","invoice_payment_attempt_id":"invpa_01J00000000000000000000000","rail":"card","started_at":"2026-03-21T15:05:00Z","status":"open"},"reused_existing":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/InvoiceCheckoutSessionResponse"}}},"description":"The existing aligned invoice checkout collection.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"201":{"content":{"application/json":{"example":{"data":{"checkout_session":{"checkout_session_id":"cs_01J00000000000000000000000","delivery_method_ids":null,"delivery_selection_required":false,"expires_at":"2026-03-21T16:05:00Z","invoice_id":"inv_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","problems":[],"recovery_mode":false,"status":"open","surface":"","url":"https://checkout.withflintpay.com/cs/cs_01J00000000000000000000000"},"hosted_checkout":{"checkout_auth_token":"csauth_example","url":"https://checkout.withflintpay.com/cs/cs_01J00000000000000000000000"},"invoice":{"cc_emails":["owner@example.com"],"collection_block_status":"","collection_mode":"buyer_initiated","created_at":"2026-03-21T15:03:00Z","credit_money":{"amount":0,"currency":"USD"},"currently_due_money":{"amount":15000,"currency":"USD"},"customer_id":"cus_01J00000000000000000000000","delivery_mode":"email","due_at":"2026-03-31T23:59:59Z","invoice_id":"inv_01J00000000000000000000000","invoice_number":"1042","is_overdue":false,"issued_at":"2026-03-21T15:04:05Z","late_fees":null,"merchant_id":"mer_01J00000000000000000000000","order_id":"ord_01J00000000000000000000000","outstanding_money":{"amount":15000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"recipient_email":"buyer@example.com","reference":"PO-1042","refund_status":"none","refunded_money":{"amount":0,"currency":"USD"},"snapshot":{"buyer_tax_identity":null,"customer_display_name":"Avery Buyer","customer_email":"buyer@example.com","line_items":[{"base_subtotal_money":{"amount":15000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"invoice_line_item_id":"","modifier_total_money":{"amount":0,"currency":"USD"},"name":"Consulting session","quantity":1,"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"},"unit_price_money":{"amount":15000,"currency":"USD"}}],"memo":"Payment due within 10 days.","merchant_display_name":"Flint Services","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":15000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":15000,"currency":"USD"}},"seller_tax_identity":null},"status":"open","updated_at":"2026-03-21T15:04:05Z","version":1,"written_off_money":{"amount":0,"currency":"USD"}},"invoice_payment_attempt":{"checkout_session_id":"cs_01J00000000000000000000000","expected_amount_money":{"amount":15000,"currency":"USD"},"invoice_id":"inv_01J00000000000000000000000","invoice_payment_attempt_id":"invpa_01J00000000000000000000000","rail":"card","started_at":"2026-03-21T15:05:00Z","status":"open"},"reused_existing":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/InvoiceCheckoutSessionResponse"}}},"description":"A newly created aligned invoice checkout collection.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]},{"InvoiceAccessTokenBearer":[]}],"summary":"Create an invoice checkout session for the current buyer","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","AUTOMATIC_TAX_PARTIAL_PAYMENT_UNSUPPORTED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","INVOICE_TAX_SNAPSHOT_MISSING","INVOICE_TAX_SNAPSHOT_STALE","ORDER_TAX_NOT_READY","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"payment"}},"/v1/me/invoices/{invoice_id}/credit-notes":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns credit notes for the authenticated merchant, newest first. Filter by invoice_id to see everything credited against one invoice.","operationId":"listMeCreditNotes","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Page token.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerCreditNoteListResponse"}}},"description":"A page of buyer-visible credit notes.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]},{"InvoiceAccessTokenBearer":[]}],"summary":"List credit notes for one of the current buyer's invoices","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_CREDIT_NOTE_STATUS","INVALID_PAGE_TOKEN","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/me/invoices/{invoice_id}/credit-notes/{credit_note_id}":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns one credit note with its lines, total, and the credit still available to allocate.","operationId":"getMeCreditNote","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Flint credit note ID.","in":"path","name":"credit_note_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuyerCreditNoteResponse"}}},"description":"The buyer-visible credit note.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]},{"InvoiceAccessTokenBearer":[]}],"summary":"Get a credit note for one of the current buyer's invoices","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/me/invoices/{invoice_id}/credit-notes/{credit_note_id}/pdf":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns the credit note document as application/pdf rather than a JSON envelope. The PDF exists from issue onward and carries your branding, the credited lines, and the invoice it corrects.","operationId":"getMeCreditNotePDF","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Flint credit note ID.","in":"path","name":"credit_note_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/pdf":{}},"description":"A PDF document.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Credit note not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]},{"InvoiceAccessTokenBearer":[]}],"summary":"Download a credit note for one of the current buyer's invoices","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","CREDIT_NOTE_NOT_ISSUED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/me/invoices/{invoice_id}/pdf":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Downloads the merchant-authenticated PDF artifact generated from the invoice snapshot.","operationId":"getMeInvoicePDF","parameters":[{"description":"Flint invoice ID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/pdf":{}},"description":"A PDF document.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"invoice not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invoice not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]},{"InvoiceAccessTokenBearer":[]}],"summary":"Download one of the current buyer's invoices","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/me/orders":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns a paginated list of orders for the authenticated merchant.","operationId":"listMeOrders","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by workflow status.","in":"query","name":"status","required":false,"schema":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},{"description":"Filter by settled collection status.","in":"query","name":"payment_status","required":false,"schema":{"enum":["unpaid","partially_paid","paid"],"type":"string","x-enum-descriptions":["Unpaid.","Partially paid.","Paid."],"x-flint-enum":"open"}},{"description":"Filter by refund progress.","in":"query","name":"refund_status","required":false,"schema":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"}},{"description":"Filter by aggregate order fulfillment status. Repeat the parameter to OR multiple statuses.","explode":true,"in":"query","name":"fulfillment_status","required":false,"schema":{"items":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"Filter by merchant-visible order number.","in":"query","name":"order_number","required":false,"schema":{"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Filter by order origin.","in":"query","name":"origin","required":false,"schema":{"enum":["virtual_terminal","payment_link","checkout","api","subscription"],"type":"string","x-enum-descriptions":["Virtual terminal.","Payment link.","Checkout.","Api.","Subscription."],"x-flint-enum":"closed"}},{"description":"Search across order number, external_reference_id, fulfillment external_reference_id, notes, and line item names.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Filter by subscription ID.","in":"query","name":"subscription_id","required":false,"schema":{"type":"string"}},{"description":"Filter by the Return that created a replacement order.","in":"query","name":"return_id","required":false,"schema":{"type":"string"}},{"description":"Filter by the ReturnResolution that created a replacement order.","in":"query","name":"return_resolution_id","required":false,"schema":{"type":"string"}},{"description":"Inclusive lower bound on the order total in minor units. Requires currency.","in":"query","name":"min_amount","required":false,"schema":{"example":500,"format":"int64","minimum":1,"type":"integer"}},{"description":"Inclusive upper bound on the order total in minor units. Requires currency.","in":"query","name":"max_amount","required":false,"schema":{"example":500,"format":"int64","minimum":1,"type":"integer"}},{"description":"ISO 4217 currency for min_amount and max_amount.","in":"query","name":"currency","required":false,"schema":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["created_at","updated_at","outstanding_money","total"],"type":"string","x-enum-descriptions":["Created at.","Updated at.","Outstanding money.","Total."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"RFC3339 lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 lower bound for updated_at.","in":"query","name":"updated_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for updated_at.","in":"query","name":"updated_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderListResponse"}}},"description":"A page of orders.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"List the current buyer's orders","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/me/orders/{order_id}":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns a single order by ID.","operationId":"getMeOrder","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Checkout session ID for buyer-facing checkout authentication.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret for buyer-facing checkout authentication.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Order","value":{"data":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Order with expanded relationships","value":{"data":{"created_at":"2026-03-17T14:30:00Z","customer":{"created_at":"2026-03-16T12:00:00Z","customer_id":"cus_123","email":"buyer@example.com","name":"Avery Buyer","updated_at":"2026-03-17T14:00:00Z"},"customer_id":"cus_123","fulfillments":[{"fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","line_items":[],"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","packages":[{"carrier":"ups","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","service_code":"ground","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"created","supported_actions":null,"tracking_number":"1Z999AA10123456784","tracking_url":"https://track.example.com/1Z999AA10123456784","version":0}],"request_status":"","shipments":[{"direction":"outbound","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","package_count":0,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"created"}],"status":"in_progress","supported_actions":null,"type":"shipment","version":0}],"line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_intent_ids":["pi_123"],"payment_intents":[{"amount_money":{"amount":5000,"currency":"USD"},"capture_method":"automatic","created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","order_id":"ord_123","payment_intent_id":"pi_123","payment_source":{"card":{"brand":"visa","last4":"4242"},"type":"card"},"refund_status":"none","status":"requires_confirmation","updated_at":"2026-03-17T14:30:00Z"}],"payment_status":"unpaid","plan_id":"plan_123","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","subscription":{"billing_anchor_day":15,"cancel_at_period_end":false,"created_at":"2026-03-17T14:30:00Z","current_period_end":"2026-04-17T14:30:00Z","current_period_start":"2026-03-17T14:30:00Z","customer_id":"cus_123","next_billing_at":"2026-04-17T14:30:00Z","plan_id":"plan_123","status":"active","subscription_id":"sub_123","updated_at":"2026-03-17T14:30:00Z"},"subscription_id":"sub_123","subscription_plan":{"billing_interval":"monthly","billing_interval_count":1,"created_at":"2026-03-17T14:30:00Z","currency":"USD","line_items":[{"name":"Membership","quantity":1,"subscription_plan_line_item_id":"spli_123","unit_price_money":{"amount":2500,"currency":"USD"}}],"name":"Monthly Membership","plan_id":"plan_123","status":"active","updated_at":"2026-03-17T14:30:00Z"},"tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"The requested order.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"examples":{"invalid_expand":{"summary":"Unsupported expand path","value":{"error":{"code":"INVALID_EXPAND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Unknown expand path \"card\" for GET /v1/orders/{order_id}. Supported values: customer, fulfillments.packages, fulfillments.shipments, payment_intents, subscription, subscription_plan.","param":"expand","remediation":{"next_steps":"Fix or remove the requested expand path; use only supported values documented for the route.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}},"validation":{"summary":"Validation error","value":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Get one of the current buyer's orders","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_EXPAND","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/me/orders/{order_id}/activities":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns a read-only, human-readable history log for an order. Use it to render timelines and debug what happened, not as a source of truth, ledger, or webhook replacement. Read the owning resource for authoritative state: the order for balances and status, the payment for payment state, the refund for refund outcomes, and the checkout session for checkout state. Do not sum balance_delta_money to compute an order balance. Informational rows such as payment_failed, refund_failed, and checkout_session_expired have a zero balance delta. The default order is newest first. Use sort_direction=asc for chronological timeline rendering. A typical chronological log might show created, payment_failed, payment, refund, then refund_failed; each row gives one reference to click through for the authoritative resource.","operationId":"listMeOrderActivities","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"Filter by activity type. Repeat the parameter or pass comma-separated values to OR multiple types.","explode":true,"in":"query","name":"type","required":false,"schema":{"items":{"enum":["created","line_item_added","line_item_updated","line_item_removed","discount_applied","discount_removed","tax_updated","requested_tip_added","requested_tip_updated","requested_tip_removed","charge_added","charge_updated","charge_removed","charge_fulfillment_updated","order_updated","adjustment","closed","payment","payment_failed","refund","refund_failed","checkout_session_created","checkout_session_expired","checkout_session_invalidated","fulfillment_created","fulfillment_updated","fulfillment_state_changed"],"type":"string","x-enum-descriptions":["Created.","Line item added.","Line item updated.","Line item removed.","Discount applied.","Discount removed.","Tax updated.","Requested tip added.","Requested tip updated.","Requested tip removed.","Charge added.","Charge updated.","Charge removed.","Charge fulfillment updated.","Order updated.","Adjustment.","Closed.","Payment.","Payment failed.","Refund.","Refund failed.","Checkout session created.","Checkout session expired.","Checkout session invalidated.","Fulfillment created.","Fulfillment updated.","Fulfillment state changed."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"activity_type":"payment","balance_delta_money":{"amount":-5000,"currency":"USD"},"created_at":"2026-03-17T14:35:00Z","description":"Payment received","order_activity_id":"act_123","payment_intent_id":"pi_123","running_balance_money":{"amount":0,"currency":"USD"}}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderActivityListResponse"}}},"description":"A page of order activities.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"List activity for one of the current buyer's orders","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/me/orders/{order_id}/receipt":{"post":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Queues another receipt email for a paid order when Flint manages receipt delivery. The recipient is derived from the order and cannot be supplied by the caller. When the merchant manages receipt delivery, ask the merchant for another copy.","operationId":"resendMeOrderReceipt","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionResponse"}}},"description":"The receipt was queued.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Idempotency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Resend the receipt for one of the current buyer's orders","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","ORDER_RECEIPT_EMAIL_UNAVAILABLE","ORDER_RECEIPT_MERCHANT_MANAGED","ORDER_RECEIPT_NOT_AVAILABLE","ORDER_RECEIPT_RESEND_RATE_LIMITED","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"external_provider_action"}},"/v1/me/packages":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Lists package records, newest created first.","operationId":"listMePackages","parameters":[{"description":"Optional shipment ID filter.","in":"query","name":"shipment_id","required":false,"schema":{"type":"string"}},{"description":"Optional fulfillment ID filter.","in":"query","name":"fulfillment_id","required":false,"schema":{"type":"string"}},{"description":"Optional order ID filter.","in":"query","name":"order_id","required":false,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by external system identifier.","in":"query","name":"external_system","required":false,"schema":{"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search across package ID, external reference ID, and tracking number.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"carrier":"ups","created_at":"2026-05-13T16:01:00Z","dimensions":{"height":4,"length":8,"unit":"in","width":6},"external_reference_id":"pkg_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","metadata":{"box":"small"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","service_code":"ground","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"created","supported_actions":["mark_packed","mark_shipped","mark_in_transit","mark_out_for_delivery","mark_delivered","mark_delivery_attempted","mark_exception"],"tracking_number":"1Z999AA10123456784","tracking_url":"https://track.example.com/1Z999AA10123456784","updated_at":"2026-05-13T16:01:00Z","version":1,"weight":{"unit":"lb","value":1.2}}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PackageListResponse"}}},"description":"Packages for the shipment.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"List the current buyer's packages","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/me/payment-methods":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns saved payment methods for the merchant, optionally filtered to a customer. By default, only active payment methods are returned.","operationId":"listMePaymentMethods","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by payment method type.","in":"query","name":"type","required":false,"schema":{"enum":["card"],"type":"string","x-enum-descriptions":["Card."],"x-flint-enum":"closed"}},{"description":"Filter by payment method status.","in":"query","name":"status","required":false,"schema":{"enum":["active","pending","expired","removed","failed"],"type":"string","x-enum-descriptions":["Active.","Pending.","Expired.","Removed.","Failed."],"x-flint-enum":"open"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"card":{"brand":"visa","exp_month":12,"exp_year":2030,"last4":"4242"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","payment_method_id":"pm_123","status":"active","type":"card","updated_at":"2026-03-17T14:30:00Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PaymentMethodListResponse"}}},"description":"A page of payment methods.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"List the current buyer's payment methods","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"},"post":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Initiates saving a payment method and returns the client setup payload needed to complete setup on the frontend.","operationId":"saveMePaymentMethod","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payment_method_type":"card"},"schema":{"$ref":"#/components/schemas/SaveMePaymentMethodRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"client_setup":{"stripe":{"account_id":"acct_123","publishable_key":"pk_test_123","setup_intent":{"client_secret":"seti_secret_123","stripe_js_call":"confirm_setup"}}},"payment_method":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","payment_method_id":"pm_123","status":"pending","type":"card","updated_at":"2026-03-17T14:30:00Z"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SavePaymentMethodResponse"}}},"description":"The initiated payment method setup record and any client-side setup details.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Add a payment method for the current buyer","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"external_provider_action"}},"/v1/me/payment-methods/{payment_method_id}":{"delete":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Soft-removes a saved payment method so it can no longer be used for future payments.","operationId":"removeMePaymentMethod","parameters":[{"description":"Flint payment method ID.","in":"path","name":"payment_method_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"success":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ActionResponse"}}},"description":"Removal acknowledged.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"payment method not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment method not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Remove one of the current buyer's payment methods","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"external_provider_action"}},"/v1/me/payment-methods/{payment_method_id}/set-default":{"post":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Sets the default payment method for the payment method's owning customer.","operationId":"setDefaultMePaymentMethod","parameters":[{"description":"Flint payment method ID.","in":"path","name":"payment_method_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"card":{"brand":"visa","exp_month":12,"exp_year":2030,"last4":"4242"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","payment_method_id":"pm_123","status":"active","type":"card","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PaymentMethodResponse"}}},"description":"The payment method that is now the default.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"payment method not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment method not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Set the current buyer's default payment method","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-route-class":"write"}},"/v1/me/payments":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns a paginated list of payment intents for the authenticated merchant.","operationId":"listMePayments","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by order ID.","in":"query","name":"order_id","required":false,"schema":{"type":"string"}},{"description":"Filter by invoice ID.","in":"query","name":"invoice_id","required":false,"schema":{"type":"string"}},{"description":"Filter by payment intent status.","in":"query","name":"status","required":false,"schema":{"enum":["requires_payment_method","requires_confirmation","requires_action","processing","requires_capture","canceled","succeeded","expired"],"type":"string","x-enum-descriptions":["Requires payment method.","Requires confirmation.","Requires action.","Processing.","Requires capture.","Canceled.","Succeeded.","Expired."],"x-flint-enum":"open"}},{"description":"Filter by payment origin.","in":"query","name":"origin","required":false,"schema":{"enum":["virtual_terminal","payment_link","checkout","api","subscription"],"type":"string","x-enum-descriptions":["Virtual terminal.","Payment link.","Checkout.","Api.","Subscription."],"x-flint-enum":"closed"}},{"description":"Filter by the latest completed risk assessment. Repeat or comma-separate values.","explode":true,"in":"query","name":"risk_level","required":false,"schema":{"items":{"enum":["normal","elevated","highest","not_assessed"],"type":"string","x-enum-descriptions":["Normal.","Elevated.","Highest.","Not assessed."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Filter by immutable payment flow. Repeat or comma-separate values.","explode":true,"in":"query","name":"payment_flow","required":false,"schema":{"items":{"enum":["checkout","payment_link","invoice","subscription_initial","subscription_renewal","virtual_terminal","api"],"type":"string","x-enum-descriptions":["Checkout.","Payment link.","Invoice.","Subscription initial.","Subscription renewal.","Virtual terminal.","Api."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Filter by linked Return ID.","in":"query","name":"return_id","required":false,"schema":{"type":"string"}},{"description":"Filter by linked ReturnResolution ID.","in":"query","name":"return_resolution_id","required":false,"schema":{"type":"string"}},{"description":"Search across payment_intent_id, external_reference_id, and receipt_email.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Inclusive lower bound in minor units. Requires currency.","in":"query","name":"min_amount","required":false,"schema":{"example":500,"format":"int64","minimum":1,"type":"integer"}},{"description":"Inclusive upper bound in minor units. Requires currency.","in":"query","name":"max_amount","required":false,"schema":{"example":500,"format":"int64","minimum":1,"type":"integer"}},{"description":"ISO 4217 currency for min_amount and max_amount.","in":"query","name":"currency","required":false,"schema":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"}},{"description":"Filter by aggregate payment-intent state preset.","in":"query","name":"state","required":false,"schema":{"enum":["with_refunds","fully_refunded","disputed","needs_action"],"type":"string","x-enum-descriptions":["With refunds.","Fully refunded.","Disputed.","Needs action."],"x-flint-enum":"closed"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["created_at","updated_at","amount"],"type":"string","x-enum-descriptions":["Created at.","Updated at.","Amount."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"RFC3339 lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 lower bound for updated_at.","in":"query","name":"updated_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for updated_at.","in":"query","name":"updated_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"amount_money":{"amount":5000,"currency":"USD"},"capture_method":"automatic","created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","external_reference_id":"cart_123","last_payment_error":null,"merchant_id":"mer_123","metadata":{"channel":"web"},"origin":"api","payment_flow":"","payment_intent_id":"pi_123","payment_options":["card","apple_pay"],"receipt_email":"buyer@example.com","refund_status":"none","risk":null,"settlement_status":"none","status":"requires_confirmation","support_reference":"","updated_at":"2026-03-17T14:30:00Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PaymentIntentListResponse"}}},"description":"A page of payment intents.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"List the current buyer's payments","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/me/refunds":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns a paginated list of refunds for the authenticated merchant.","operationId":"listMeRefunds","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by order ID.","in":"query","name":"order_id","required":false,"schema":{"type":"string"}},{"description":"Filter by payment intent ID.","in":"query","name":"payment_intent_id","required":false,"schema":{"type":"string"}},{"description":"Filter by refund status.","in":"query","name":"status","required":false,"schema":{"enum":["pending","in_transit","succeeded","failed","requires_action","canceled","partially_succeeded"],"type":"string","x-enum-descriptions":["Pending.","In transit.","Succeeded.","Failed.","Requires action.","Canceled.","Partially succeeded."],"x-flint-enum":"open"}},{"description":"Repeat the parameter to filter by multiple refund reasons.","explode":true,"in":"query","name":"reason","required":false,"schema":{"items":{"enum":["duplicate","fraudulent","requested_by_customer","defective_product","wrong_item_shipped","never_received","not_as_described","arrived_too_late","customer_changed_mind","better_price_found","accidental_order","other"],"type":"string","x-enum-descriptions":["Duplicate.","Fraudulent.","Requested by customer.","Defective product.","Wrong item shipped.","Never received.","Not as described.","Arrived too late.","Customer changed mind.","Better price found.","Accidental order.","Other."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Filter by refund method.","in":"query","name":"refund_method","required":false,"schema":{"enum":["original_payment"],"type":"string","x-enum-descriptions":["Original payment."],"x-flint-enum":"closed"}},{"description":"Inclusive lower bound in minor units. Requires currency.","in":"query","name":"min_amount","required":false,"schema":{"example":500,"format":"int64","minimum":1,"type":"integer"}},{"description":"Inclusive upper bound in minor units. Requires currency.","in":"query","name":"max_amount","required":false,"schema":{"example":500,"format":"int64","minimum":1,"type":"integer"}},{"description":"ISO 4217 currency for min_amount and max_amount.","in":"query","name":"currency","required":false,"schema":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Filter by linked Return ID.","in":"query","name":"return_id","required":false,"schema":{"type":"string"}},{"description":"Filter by linked ReturnResolution ID.","in":"query","name":"return_resolution_id","required":false,"schema":{"type":"string"}},{"description":"Search across refund_id, external_reference_id, and reason_message.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["created_at","updated_at","amount"],"type":"string","x-enum-descriptions":["Created at.","Updated at.","Amount."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"RFC3339 lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 lower bound for updated_at.","in":"query","name":"updated_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for updated_at.","in":"query","name":"updated_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"amount_money":{"amount":1000,"currency":"USD"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","metadata":{"ticket_id":"tkt_123"},"order_id":"ord_123","payment_intent_id":"pi_123","payment_refunds":[{"amount_money":{"amount":1000,"currency":"USD"},"payment_intent_id":"pi_123","refunded_tip_money":{"amount":100,"currency":"USD"},"status":"succeeded"}],"reason":"requested_by_customer","refund_id":"ref_123","refund_method":"original_payment","refunded_tip_money":{"amount":100,"currency":"USD"},"status":"succeeded","updated_at":"2026-03-17T14:30:00Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/RefundListResponse"}}},"description":"A page of refunds.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"List the current buyer's refunds","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/me/return-previews":{"post":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Preview return eligibility or resolution amounts without creating a Return or reserving quantity. Set mode to eligibility or resolution and send the matching input object.","operationId":"createMeReturnPreview","parameters":[{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnPreviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnPreviewResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Preview Return eligibility or resolution amounts for the current buyer","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/me/return-resolutions/{resolution_id}/checkout-session":{"post":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Create or reuse the standard hosted checkout session for a buyer-owed replacement Order linked to this Return resolution.","operationId":"createMeReturnResolutionCheckoutSession","parameters":[{"description":"Flint return resolution id.","in":"path","name":"resolution_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateReturnResolutionCheckoutSessionResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Create a Return resolution checkout session for the current buyer","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-route-class":"write"}},"/v1/me/returns":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. List Returns for the merchant, filtered by order, customer, status, decision, merchandise, resolution, or creation window. Filter by idempotency_key to recover a create whose response never arrived.","operationId":"listMeReturns","parameters":[{"description":"RFC3339 created after filter.","in":"query","name":"created_after","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"RFC3339 created before filter.","in":"query","name":"created_before","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Filter by decision status.","explode":false,"in":"query","name":"decision_status","required":false,"schema":{"items":{"enum":["pending","approved","partially_approved","declined"],"type":"string","x-enum-descriptions":["Pending.","Approved.","Partially approved.","Declined."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Filter by merchandise status.","explode":false,"in":"query","name":"merchandise_status","required":false,"schema":{"items":{"enum":["not_required","awaiting_handoff","in_transit","partially_received","received","inspection_required","partially_inspected","inspection_review_required","disposition_required","resolved","exception"],"type":"string","x-enum-descriptions":["Not required.","Awaiting handoff.","In transit.","Partially received.","Received.","Inspection required.","Partially inspected.","Inspection review required.","Disposition required.","Resolved.","Exception."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"Filter by order id.","in":"query","name":"order_id","required":false,"schema":{"type":"string"}},{"description":"Page size. Defaults to 20 and is capped at 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Search by return ID, return number, external reference ID, the order's number, or the buyer's email.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Filter by receiving location id.","in":"query","name":"receiving_location_id","required":false,"schema":{"type":"string"}},{"description":"Filter by resolution status.","explode":false,"in":"query","name":"resolution_status","required":false,"schema":{"items":{"enum":["not_selected","pending","partially_fulfilled","requires_action","fulfilled","failed"],"type":"string","x-enum-descriptions":["Not selected.","Pending.","Partially fulfilled.","Requires action.","Fulfilled.","Failed."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"Filter by resolution type.","explode":false,"in":"query","name":"resolution_type","required":false,"schema":{"items":{"enum":["refund","exchange","replacement","no_monetary_action","correction"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action.","Correction."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Filter by return number.","in":"query","name":"return_number","required":false,"schema":{"type":"string"}},{"description":"Filter by return reason id.","in":"query","name":"return_reason_id","required":false,"schema":{"type":"string"}},{"description":"Filter by status.","explode":false,"in":"query","name":"status","required":false,"schema":{"items":{"enum":["requested","open","completed","declined","canceled"],"type":"string","x-enum-descriptions":["Requested.","Open.","Completed.","Declined.","Canceled."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"RFC3339 updated after filter.","in":"query","name":"updated_after","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"RFC3339 updated before filter.","in":"query","name":"updated_before","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Filter by work type. Matches only returns that are still requested or open.","explode":false,"in":"query","name":"work_type","required":false,"schema":{"items":{"enum":["decision","handoff","receipt","inspection","disposition","resolution","exception"],"type":"string","x-enum-descriptions":["Decision.","Handoff.","Receipt.","Inspection.","Disposition.","Resolution.","Exception."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListReturnsResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"List the current buyer's Returns","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"},"post":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Create a requested Return. When no policy matches, the Return remains available for merchant review rather than failing creation.","operationId":"createMeReturn","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Create a Return for the current buyer","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-route-class":"write"}},"/v1/me/returns/{return_id}":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Retrieve a Return with its line items, policy evaluation, financial summary, and completion blockers. Supports expand for the order, the customer, and each line item's reason and fulfillment.","operationId":"getMeReturn","parameters":[{"description":"Flint return id.","in":"path","name":"return_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Resource without expanded relationships","value":{"data":{"customer_id":"cus_01K1CUSTOMER00000000000","line_items":[{"fulfillment_id":"ful_01K1FULFILLMENT000000000","return_line_item_id":"retli_01K1LINE000000000000000","return_reason_id":"rrsn_01K1REASON000000000000"}],"order_id":"ord_01K1ORDER000000000000000","return_id":"ret_01K1RETURN000000000000000"},"request_id":"req_123"}},"expanded":{"summary":"Resource with expanded relationships","value":{"data":{"customer":{"customer_id":"cus_01K1CUSTOMER00000000000","email":"buyer@example.com"},"customer_id":"cus_01K1CUSTOMER00000000000","line_items":[{"fulfillment":{"fulfillment_id":"ful_01K1FULFILLMENT000000000","order_id":"ord_01K1ORDER000000000000000","status":"completed","type":"shipment"},"fulfillment_id":"ful_01K1FULFILLMENT000000000","return_line_item_id":"retli_01K1LINE000000000000000","return_reason":{"handle":"changed_mind","name":"Changed mind","return_reason_id":"rrsn_01K1REASON000000000000","source":"flint","status":"active"},"return_reason_id":"rrsn_01K1REASON000000000000"}],"order":{"order_id":"ord_01K1ORDER000000000000000","status":"open"},"order_id":"ord_01K1ORDER000000000000000","return_id":"ret_01K1RETURN000000000000000"},"request_id":"req_123"}}},"schema":{"$ref":"#/components/schemas/GetReturnResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Get one of the current buyer's Returns","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/me/returns/{return_id}/cancel":{"post":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Cancel a Return before any merchandise or value work commits. Cancellation is refused once a receipt, inspection, disposition, or resolution exists.","operationId":"cancelMeReturn","parameters":[{"description":"Flint return id.","in":"path","name":"return_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelReturnRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelReturnResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Cancel one of the current buyer's Returns","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-route-class":"write"}},"/v1/me/shipments":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Lists shipment execution records, newest created first.","operationId":"listMeShipments","parameters":[{"description":"Optional order ID filter.","in":"query","name":"order_id","required":false,"schema":{"type":"string"}},{"description":"Optional fulfillment ID filter.","in":"query","name":"fulfillment_id","required":false,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by external system identifier.","in":"query","name":"external_system","required":false,"schema":{"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search across shipment ID, external reference ID, and tracking number.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Filter by linked Return ID.","in":"query","name":"return_id","required":false,"schema":{"type":"string"}},{"description":"RFC3339 lower bound for handed_off_at.","in":"query","name":"handed_off_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for handed_off_at.","in":"query","name":"handed_off_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"created_at":"2026-05-13T15:59:00Z","direction":"outbound","external_reference_id":"ship_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","handed_off_at":"2026-05-13T16:00:00Z","metadata":{"warehouse":"east"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_count":0,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","shipped_at":"2026-05-13T16:00:00Z","status":"created","updated_at":"2026-05-13T16:00:00Z","version":1}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ShipmentListResponse"}}},"description":"Shipments for the fulfillment.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"List the current buyer's shipments","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/me/subscriptions":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns a paginated list of subscriptions for the authenticated merchant.","operationId":"listMeSubscriptions","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by subscription status. Repeat the parameter or pass comma-separated values to match multiple statuses.","explode":true,"in":"query","name":"status","required":false,"schema":{"items":{"enum":["trialing","active","paused","past_due","canceled","incomplete"],"type":"string","x-enum-descriptions":["Trialing.","Active.","Paused.","Past due.","Canceled.","Incomplete."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"Filter by the system that supplies billing dates.","in":"query","name":"billing_schedule_owner","required":false,"schema":{"enum":["flint","external"],"type":"string","x-enum-descriptions":["Flint.","External."],"x-flint-enum":"closed"}},{"description":"Filter external schedules by whether they need another billing date.","in":"query","name":"awaiting_billing_schedule","required":false,"schema":{"type":"boolean"}},{"description":"When true, returns subscriptions scheduled to cancel at the end of the current period that are not yet canceled. When false, returns every other subscription.","in":"query","name":"cancel_at_period_end","required":false,"schema":{"type":"boolean"}},{"description":"Filter by Flint subscription plan ID.","in":"query","name":"plan_id","required":false,"schema":{"type":"string"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["created_at","updated_at","next_billing_at"],"type":"string","x-enum-descriptions":["Created at.","Updated at.","Next billing at."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"RFC3339 lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 lower bound for updated_at.","in":"query","name":"updated_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for updated_at.","in":"query","name":"updated_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 lower bound for next_billing_at.","in":"query","name":"next_billing_at_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for next_billing_at.","in":"query","name":"next_billing_at_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"True matches past_due, incomplete, or active subscriptions with next_billing_at more than 24 hours ago. False excludes those subscriptions. Other filters still apply.","in":"query","name":"needs_attention","required":false,"schema":{"type":"boolean"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Subscription list","value":{"data":[{"billing_anchor_day":15,"billing_interval":"monthly","billing_interval_count":1,"billing_schedule_owner":"flint","cancel_at_period_end":false,"created_at":"2026-03-17T14:30:00Z","current_period_end":"2026-04-17T14:30:00Z","current_period_start":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","metadata":{"source":"api"},"next_billing_at":"2026-04-17T14:30:00Z","next_retry_at":null,"payment_method_id":"pm_123","plan_id":"plan_123","recurring_amount_money":{"amount":4500,"currency":"USD"},"status":"active","subscription_id":"sub_123","updated_at":"2026-03-17T14:30:00Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Subscription list with expanded relationships","value":{"data":[{"billing_anchor_day":15,"billing_interval":"monthly","billing_interval_count":1,"billing_schedule_owner":"flint","cancel_at_period_end":false,"created_at":"2026-03-17T14:30:00Z","current_period_end":"2026-04-17T14:30:00Z","current_period_start":"2026-03-17T14:30:00Z","customer":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","email":"jane@example.com","name":"Jane Doe","phone":"+14155552671","updated_at":"2026-03-17T14:30:00Z"},"customer_id":"cus_123","merchant_id":"mer_123","metadata":{"source":"api"},"next_billing_at":"2026-04-17T14:30:00Z","next_retry_at":null,"payment_method_id":"pm_123","plan_id":"plan_123","recurring_amount_money":{"amount":4500,"currency":"USD"},"status":"active","subscription_id":"sub_123","subscription_plan":{"billing_interval":"monthly","billing_interval_count":1,"created_at":"2026-03-17T14:30:00Z","currency":"USD","line_items":[{"name":"Membership","quantity":1,"subscription_plan_line_item_id":"spli_123","unit_price_money":{"amount":2500,"currency":"USD"}}],"name":"Monthly Membership","plan_id":"plan_123","status":"active","updated_at":"2026-03-17T14:30:00Z"},"updated_at":"2026-03-17T14:30:00Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/SubscriptionListResponse"}}},"description":"A page of subscriptions.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"List the current buyer's subscriptions","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_BILLING_SCHEDULE_OWNER","INVALID_BOOLEAN","INVALID_PAGE_SIZE","INVALID_PAGE_TOKEN","INVALID_REQUEST","INVALID_SORT_BY","INVALID_SORT_DIRECTION","INVALID_SORT_FIELD","INVALID_STATUS","INVALID_TIMESTAMP","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE","UNSUPPORTED_QUERY_PARAM"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/me/subscriptions/{subscription_id}":{"get":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Returns a single subscription by ID.","operationId":"getMeSubscription","parameters":[{"description":"Flint subscription ID.","in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Subscription","value":{"data":{"billing_anchor_day":15,"billing_interval":"monthly","billing_interval_count":1,"billing_schedule_owner":"flint","cancel_at_period_end":false,"created_at":"2026-03-17T14:30:00Z","current_period_end":"2026-04-17T14:30:00Z","current_period_start":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","metadata":{"source":"api"},"next_billing_at":"2026-04-17T14:30:00Z","next_retry_at":null,"payment_method_id":"pm_123","plan_id":"plan_123","recurring_amount_money":{"amount":4500,"currency":"USD"},"status":"active","subscription_id":"sub_123","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Subscription with expanded relationships","value":{"data":{"billing_anchor_day":15,"billing_interval":"monthly","billing_interval_count":1,"billing_schedule_owner":"flint","cancel_at_period_end":false,"created_at":"2026-03-17T14:30:00Z","current_period_end":"2026-04-17T14:30:00Z","current_period_start":"2026-03-17T14:30:00Z","customer":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","email":"jane@example.com","name":"Jane Doe","phone":"+14155552671","updated_at":"2026-03-17T14:30:00Z"},"customer_id":"cus_123","merchant_id":"mer_123","metadata":{"source":"api"},"next_billing_at":"2026-04-17T14:30:00Z","next_retry_at":null,"payment_method":{"card":{"brand":"visa","exp_month":12,"exp_year":2030,"last4":"4242"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","payment_method_id":"pm_123","status":"active","type":"card","updated_at":"2026-03-17T14:30:00Z"},"payment_method_id":"pm_123","plan_id":"plan_123","recurring_amount_money":{"amount":4500,"currency":"USD"},"status":"active","subscription_id":"sub_123","subscription_plan":{"billing_interval":"monthly","billing_interval_count":1,"created_at":"2026-03-17T14:30:00Z","currency":"USD","line_items":[{"name":"Membership","quantity":1,"subscription_plan_line_item_id":"spli_123","unit_price_money":{"amount":2500,"currency":"USD"}}],"name":"Monthly Membership","plan_id":"plan_123","status":"active","updated_at":"2026-03-17T14:30:00Z"},"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}},"description":"The requested subscription.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"subscription not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Subscription not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Get one of the current buyer's subscriptions","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/me/subscriptions/{subscription_id}/cancel":{"post":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Cancels a subscription immediately or at period end. Response may include advisory contract information.","operationId":"cancelMeSubscription","parameters":[{"description":"Flint subscription ID.","in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"cancel_immediately":false},"schema":{"$ref":"#/components/schemas/CancelSubscriptionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"billing_anchor_day":15,"cancel_at_period_end":true,"created_at":"2026-03-17T14:30:00Z","current_period_end":"2026-04-17T14:30:00Z","current_period_start":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","metadata":{"source":"api"},"next_billing_at":"2026-04-17T14:30:00Z","next_retry_at":null,"payment_method_id":"pm_123","plan_id":"plan_123","status":"active","subscription_id":"sub_123","updated_at":"2026-03-20T10:00:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CancelSubscriptionResponse"}}},"description":"The canceled subscription state.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"subscription not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Subscription not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Cancel one of the current buyer's subscriptions","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","CONCURRENT_MODIFICATION","CUSTOMER_DELETION_PROCESSING","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"external_provider_action"}},"/v1/me/subscriptions/{subscription_id}/pause":{"post":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Pauses a subscription immediately, optionally for a fixed number of billing cycles.","operationId":"pauseMeSubscription","parameters":[{"description":"Flint subscription ID.","in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"pause_duration_cycles":2},"schema":{"$ref":"#/components/schemas/PauseSubscriptionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"billing_anchor_day":15,"billing_interval":"monthly","billing_interval_count":1,"billing_schedule_owner":"flint","cancel_at_period_end":false,"created_at":"2026-03-17T14:30:00Z","current_period_end":"2026-04-17T14:30:00Z","current_period_start":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","metadata":{"source":"api"},"next_billing_at":"2026-04-17T14:30:00Z","next_retry_at":null,"payment_method_id":"pm_123","plan_id":"plan_123","recurring_amount_money":{"amount":4500,"currency":"USD"},"status":"active","subscription_id":"sub_123","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}},"description":"The paused subscription.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"subscription not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Subscription not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"CANNOT_PAUSE","current_status":"past_due","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Only active subscriptions can be paused.","param":"subscription_id","remediation":{"next_steps":"Fetch the subscription and pause it only from an active state.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Pause one of the current buyer's subscriptions","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","CANNOT_PAUSE","CONCURRENT_MODIFICATION","CUSTOMER_DELETION_PROCESSING","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"external_provider_action"}},"/v1/me/subscriptions/{subscription_id}/payment-method":{"post":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Changes the subscription to an active payment method owned by the same customer.","operationId":"changeMeSubscriptionPaymentMethod","parameters":[{"description":"Flint subscription ID.","in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payment_method_id":"pm_123"},"schema":{"$ref":"#/components/schemas/ChangeSubscriptionPaymentMethodRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}},"description":"The updated subscription.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Idempotency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Change the payment method for one of the current buyer's subscriptions","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","CONCURRENT_MODIFICATION","CUSTOMER_DELETION_PROCESSING","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_REQUEST","PAYMENT_METHOD_CUSTOMER_MISMATCH","PAYMENT_METHOD_NOT_ACTIVE","PAYMENT_METHOD_NOT_READY","PAYMENT_METHOD_REQUIRED","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SUBSCRIPTION_CANCELED"],"x-flint-partner-access":"unsupported","x-flint-route-class":"write"}},"/v1/me/subscriptions/{subscription_id}/reactivate":{"post":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Clears a pending period-end cancellation without changing the current billing period.","operationId":"reactivateMeSubscription","parameters":[{"description":"Flint subscription ID.","in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}},"description":"The reactivated subscription.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Idempotency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Reactivate one of the current buyer's subscriptions","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","CONCURRENT_MODIFICATION","CUSTOMER_DELETION_PROCESSING","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_REQUEST","NO_FIELDS_TO_UPDATE","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SUBSCRIPTION_CANCELED","USE_CANCEL_SUBSCRIPTION"],"x-flint-partner-access":"unsupported","x-flint-route-class":"write"}},"/v1/me/subscriptions/{subscription_id}/resume":{"post":{"description":"Uses the customer identity fixed by the customer session. The request cannot select a customer_id. Resumes a paused subscription.","operationId":"resumeMeSubscription","parameters":[{"description":"Flint subscription ID.","in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"billing_anchor_day":15,"billing_interval":"monthly","billing_interval_count":1,"billing_schedule_owner":"flint","cancel_at_period_end":false,"created_at":"2026-03-17T14:30:00Z","current_period_end":"2026-04-17T14:30:00Z","current_period_start":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","metadata":{"source":"api"},"next_billing_at":"2026-04-17T14:30:00Z","next_retry_at":null,"payment_method_id":"pm_123","plan_id":"plan_123","recurring_amount_money":{"amount":4500,"currency":"USD"},"status":"active","subscription_id":"sub_123","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}},"description":"The resumed subscription.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"subscription not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Subscription not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"CANNOT_RESUME","current_status":"active","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Only paused subscriptions can be resumed.","param":"subscription_id","remediation":{"next_steps":"Fetch the subscription and resume it only from a paused state.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CustomerSessionBearer":[]}],"summary":"Resume one of the current buyer's subscriptions","tags":["customer_account"],"x-flint-error-codes":["AUTH_REQUIRED","CANNOT_RESUME","CANNOT_RESUME_INITIAL_PAYMENT_PENDING","CANNOT_RESUME_PAST_DUE_PAYMENT_REQUIRED","CONCURRENT_MODIFICATION","CUSTOMER_DELETION_PROCESSING","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"external_provider_action"}},"/v1/merchant-account-sessions":{"post":{"description":"Creates an embedded browser handoff for one or more allowlisted account components.","operationId":"createMerchantAccountSession","parameters":[{"description":"Optional idempotency key for safe retries. Completed retries create a fresh launch session instead of replaying a prior client secret.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"collection_strategy":"upfront","components":["account_onboarding"],"future_requirements":"include"},"schema":{"$ref":"#/components/schemas/MerchantAccountSessionCreateRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"components":["account_onboarding"],"effective_policy":{"collection_strategy":"upfront","future_requirements":"include","targeting":"all"},"external_action":{"kind":"embedded","launch_token":"aslaunch_v1.example","launch_token_expires_at":"2026-03-18T20:30:00Z","provider_session_expires_at":"2026-03-18T20:00:00Z","stripe":{"client_secret":"acct_session_client_secret_123","components":[{"component":"account_onboarding","component_props":{"collectionOptions":{"fields":"eventually_due","futureRequirements":"include"}}}],"publishable_key":"pk_test_123"}},"requirements":{"current_deadline_at":"2026-04-01T00:00:00Z","currently_due":["merchant_category_code","business_website"],"eventually_due":["representative_first_name"]}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/MerchantAccountSessionResponse"}}},"description":"The merchant-account-session launch and effective policy.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"examples":{"invalid_component":{"summary":"invalid component","value":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_INVALID_COMPONENT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"components must contain unique supported values.","param":"components","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}},"invalid_launch_token":{"summary":"invalid launch token","value":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_INVALID_LAUNCH_TOKEN","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"launch_token is invalid or expired. Create a new account session.","param":"launch_token","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}},"invalid_policy_combination":{"summary":"invalid policy combination","value":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_INVALID_POLICY_COMBINATION","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The requested onboarding policy is invalid.","param":"collection_strategy","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}},"policy_not_supported":{"summary":"policy not supported","value":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_POLICY_NOT_SUPPORTED_BY_COMPONENT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The selected component cannot implement the requested policy.","param":"components","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}},"targeted_remediation_unavailable":{"summary":"targeted remediation unavailable","value":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_TARGETED_REMEDIATION_UNAVAILABLE","details":[{"code":"MERCHANT_ACCOUNT_SESSION_UNMAPPABLE_REQUIREMENT_ID","message":"Requirement ID cannot be targeted: additional_account_information.","param":"targeted_requirement_ids","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Targeted remediation is unavailable for one or more requirement IDs.","param":"targeted_requirement_ids","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid component, policy, targeting, or launch token.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Onboarding session or API key required.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_LAUNCH_TOKEN_SCOPE_MISMATCH","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"launch_token does not belong to the authenticated merchant environment.","param":"launch_token","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authorization_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The launch token or authenticated credential is not authorized for this merchant environment.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"examples":{"merchant_ineligible":{"summary":"Merchant is ineligible","value":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_INELIGIBLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"This merchant is not eligible to create a merchant account session. Contact Flint support.","remediation":{"next_steps":"Complete the required merchant readiness or onboarding action before retrying.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}}},"setup_repair_required":{"summary":"Live setup requires support repair","value":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_ACCOUNT_SETUP_REPAIR_REQUIRED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Account setup is not available for merchant account sessions. Contact Flint support to repair account setup before creating a merchant account session.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}}},"setup_required":{"summary":"Account setup required","value":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_ACCOUNT_SETUP_REQUIRED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Account setup must be completed before creating a merchant account session. Use the onboarding API first.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}}},"setup_unavailable":{"summary":"Sandbox setup can be restarted","value":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_ACCOUNT_SETUP_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Account setup is not available for merchant account sessions. Use the onboarding API to restart setup before creating a merchant account session.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Account setup must be completed, restarted, repaired, or eligible before creating a merchant account session.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"example":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_PREPARATION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Merchant account session could not be prepared. Try again.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Merchant account session preparation failed before the browser launch was created.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Merchant account sessions are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"OnboardingSessionBearer":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create merchant account session","tags":["onboarding","merchant_account_sessions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","MERCHANT_ACCOUNT_SESSION_ACCOUNT_SETUP_REPAIR_REQUIRED","MERCHANT_ACCOUNT_SESSION_ACCOUNT_SETUP_REQUIRED","MERCHANT_ACCOUNT_SESSION_ACCOUNT_SETUP_UNAVAILABLE","MERCHANT_ACCOUNT_SESSION_INELIGIBLE","MERCHANT_ACCOUNT_SESSION_INVALID_COMPONENT","MERCHANT_ACCOUNT_SESSION_INVALID_LAUNCH_TOKEN","MERCHANT_ACCOUNT_SESSION_INVALID_POLICY_COMBINATION","MERCHANT_ACCOUNT_SESSION_LAUNCH_TOKEN_SCOPE_MISMATCH","MERCHANT_ACCOUNT_SESSION_POLICY_NOT_SUPPORTED_BY_COMPONENT","MERCHANT_ACCOUNT_SESSION_PREPARATION_FAILED","MERCHANT_ACCOUNT_SESSION_TARGETED_REMEDIATION_UNAVAILABLE","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["merchants.account_sessions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/merchant-account-sessions/refresh":{"post":{"description":"Creates a fresh provider session from a signed launch token after rechecking the authenticated principal, merchant environment, account controller, and component grant.","operationId":"refreshMerchantAccountSession","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"launch_token":"aslaunch_v1.example"},"schema":{"$ref":"#/components/schemas/MerchantAccountSessionRefreshRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"components":["account_onboarding"],"effective_policy":{"collection_strategy":"upfront","future_requirements":"include","targeting":"all"},"external_action":{"kind":"embedded","launch_token":"aslaunch_v1.example","launch_token_expires_at":"2026-03-18T20:30:00Z","provider_session_expires_at":"2026-03-18T20:00:00Z","stripe":{"client_secret":"acct_session_client_secret_123","components":[{"component":"account_onboarding","component_props":{"collectionOptions":{"fields":"eventually_due","futureRequirements":"include"}}}],"publishable_key":"pk_test_123"}},"requirements":{"current_deadline_at":"2026-04-01T00:00:00Z","currently_due":["merchant_category_code","business_website"],"eventually_due":["representative_first_name"]}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/MerchantAccountSessionResponse"}}},"description":"The refreshed merchant account session.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"examples":{"invalid_component":{"summary":"invalid component","value":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_INVALID_COMPONENT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"components must contain unique supported values.","param":"components","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}},"invalid_launch_token":{"summary":"invalid launch token","value":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_INVALID_LAUNCH_TOKEN","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"launch_token is invalid or expired. Create a new account session.","param":"launch_token","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}},"invalid_policy_combination":{"summary":"invalid policy combination","value":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_INVALID_POLICY_COMBINATION","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The requested onboarding policy is invalid.","param":"collection_strategy","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}},"policy_not_supported":{"summary":"policy not supported","value":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_POLICY_NOT_SUPPORTED_BY_COMPONENT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The selected component cannot implement the requested policy.","param":"components","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}},"targeted_remediation_unavailable":{"summary":"targeted remediation unavailable","value":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_TARGETED_REMEDIATION_UNAVAILABLE","details":[{"code":"MERCHANT_ACCOUNT_SESSION_UNMAPPABLE_REQUIREMENT_ID","message":"Requirement ID cannot be targeted: additional_account_information.","param":"targeted_requirement_ids","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Targeted remediation is unavailable for one or more requirement IDs.","param":"targeted_requirement_ids","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid launch token.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Onboarding session or API key required.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_LAUNCH_TOKEN_SCOPE_MISMATCH","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"launch_token does not belong to the authenticated merchant environment.","param":"launch_token","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authorization_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The launch token is not authorized for this principal and merchant environment.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"examples":{"merchant_ineligible":{"summary":"Merchant is ineligible","value":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_INELIGIBLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"This merchant is not eligible to create a merchant account session. Contact Flint support.","remediation":{"next_steps":"Complete the required merchant readiness or onboarding action before retrying.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}}},"setup_repair_required":{"summary":"Live setup requires support repair","value":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_ACCOUNT_SETUP_REPAIR_REQUIRED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Account setup is not available for merchant account sessions. Contact Flint support to repair account setup before creating a merchant account session.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}}},"setup_required":{"summary":"Account setup required","value":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_ACCOUNT_SETUP_REQUIRED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Account setup must be completed before creating a merchant account session. Use the onboarding API first.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}}},"setup_unavailable":{"summary":"Sandbox setup can be restarted","value":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_ACCOUNT_SETUP_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Account setup is not available for merchant account sessions. Use the onboarding API to restart setup before creating a merchant account session.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The account is not eligible for refresh.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"example":{"error":{"code":"MERCHANT_ACCOUNT_SESSION_PREPARATION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Merchant account session could not be prepared. Try again.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Merchant account session preparation failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Merchant account sessions are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"OnboardingSessionBearer":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Refresh merchant account session","tags":["onboarding","merchant_account_sessions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","MERCHANT_ACCOUNT_SESSION_ACCOUNT_SETUP_REPAIR_REQUIRED","MERCHANT_ACCOUNT_SESSION_ACCOUNT_SETUP_REQUIRED","MERCHANT_ACCOUNT_SESSION_ACCOUNT_SETUP_UNAVAILABLE","MERCHANT_ACCOUNT_SESSION_INELIGIBLE","MERCHANT_ACCOUNT_SESSION_INVALID_COMPONENT","MERCHANT_ACCOUNT_SESSION_INVALID_LAUNCH_TOKEN","MERCHANT_ACCOUNT_SESSION_INVALID_POLICY_COMBINATION","MERCHANT_ACCOUNT_SESSION_LAUNCH_TOKEN_SCOPE_MISMATCH","MERCHANT_ACCOUNT_SESSION_POLICY_NOT_SUPPORTED_BY_COMPONENT","MERCHANT_ACCOUNT_SESSION_PREPARATION_FAILED","MERCHANT_ACCOUNT_SESSION_TARGETED_REMEDIATION_UNAVAILABLE","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["merchants.account_sessions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/merchant-billing-balances":{"get":{"description":"Returns what the merchant currently owes Flint and owns as account credit by currency.","operationId":"listMerchantBillingBalances","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantBillingBalanceListResponse"}}},"description":"Merchant billing balances for the authenticated merchant environment.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Merchant billing data could not be read.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List merchant billing balances","tags":["merchant_billing"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["merchant_billing.read"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"read"}},"/v1/merchant-billing-balances/{merchant_billing_balance_id}":{"get":{"description":"Returns what the merchant currently owes Flint and owns as account credit in one currency.","operationId":"getMerchantBillingBalance","parameters":[{"description":"Flint merchant billing balance ID.","in":"path","name":"merchant_billing_balance_id","required":true,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantBillingBalanceResponse"}}},"description":"Returns what the merchant currently owes Flint and owns as account credit in one currency.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Merchant billing resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Merchant billing data could not be read.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get a merchant billing balance","tags":["merchant_billing"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["merchant_billing.read"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"read"}},"/v1/merchant-subscription-invoices":{"get":{"description":"Returns invoices issued by Flint for the authenticated merchant environment.","operationId":"listMerchantSubscriptionInvoices","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantSubscriptionInvoiceListResponse"}}},"description":"Returns invoices issued by Flint for the authenticated merchant environment.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Merchant billing data could not be read.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List merchant subscription invoices","tags":["merchant_billing"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["merchant_billing.read"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"read"}},"/v1/merchant-subscription-invoices/{merchant_subscription_invoice_id}":{"get":{"description":"Returns one invoice issued by Flint for the authenticated merchant environment.","operationId":"getMerchantSubscriptionInvoice","parameters":[{"description":"Flint merchant subscription invoice ID.","in":"path","name":"merchant_subscription_invoice_id","required":true,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MerchantSubscriptionInvoiceResponse"}}},"description":"Returns one invoice issued by Flint for the authenticated merchant environment.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Merchant billing resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Merchant billing data could not be read.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get a merchant subscription invoice","tags":["merchant_billing"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["merchant_billing.read"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"read"}},"/v1/merchants/{merchant_id}":{"get":{"description":"Returns the authenticated merchant by ID.","operationId":"getMerchant","parameters":[{"description":"Flint merchant ID.","in":"path","name":"merchant_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: organization. Expansion requires merchants.profile.read plus accounts.organizations.read. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=organization\u0026expand=organization, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["organization"],"type":"string","x-enum-descriptions":["Organization."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Merchant","value":{"data":{"address":{"city":"New York","country":"US","line1":"123 Main St","postal_code":"10001","state":"NY"},"banners":[{"message":"Your account is ready to accept payments.","style":"success"}],"business_name":"Flint Events LLC","business_type":"company","created_at":"2026-03-17T14:30:00Z","email":"owner@example.com","has_past_due":false,"logo":{"alt":"Merchant logo","height":512,"url":"https://images.withflintpay.com/ia_merchant_logo/original","width":512},"merchant_id":"mer_123","metadata":{"segment":"events"},"observed_at":"2026-06-28T00:00:00Z","onboarding_status":"completed","payments":{"next_actions":[],"status":"ready","status_reason":null},"payouts":{"next_actions":[{"action_type":"create_merchant_account_session","merchant_account_session":{"collection_strategy":"upfront","component":"account_onboarding","future_requirements":"omit"},"reason_code":"requirements_past_due","reason_message":"Create a merchant account session to complete past-due merchant requirements.","required_fields":["components"],"required_scope":"merchants.account_sessions.write","url":"/v1/merchant-account-sessions"}],"status":"blocked","status_reason":"requirements_past_due"},"phone":"+14155552671","requirements":{"currently_due":[],"disabled_reason":"requirements_past_due","eventually_due":[],"past_due":["business_website"],"pending_verification":[]},"status":"active","support_email":"support@example.com","support_phone":"+14155552671","support_url":"https://example.com/support","updated_at":"2026-03-17T14:30:00Z","version":1,"website_url":"https://withflintpay.com"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Merchant with expanded organization","value":{"data":{"address":{"city":"New York","country":"US","line1":"123 Main St","postal_code":"10001","state":"NY"},"banners":[{"message":"Your account is ready to accept payments.","style":"success"}],"business_name":"Flint Events LLC","business_type":"company","created_at":"2026-03-17T14:30:00Z","email":"owner@example.com","has_past_due":false,"logo":{"alt":"Merchant logo","height":512,"url":"https://images.withflintpay.com/ia_merchant_logo/original","width":512},"merchant_id":"mer_123","metadata":{"segment":"events"},"observed_at":"2026-06-28T00:00:00Z","onboarding_status":"completed","organization":{"created_at":"2026-03-18T09:15:00Z","name":"Northeast Region","organization_id":"org_01JQ4X6Q1G6NMBM4Q0E2W9X6YZ","parent_organization_id":"org_01JQ4X2R0W0RTM8VJQ8YQ7P9AB","status":"active","updated_at":"2026-03-18T09:15:00Z"},"organization_id":"org_01JQ4X6Q1G6NMBM4Q0E2W9X6YZ","payments":{"next_actions":[],"status":"ready","status_reason":null},"payouts":{"next_actions":[{"action_type":"create_merchant_account_session","merchant_account_session":{"collection_strategy":"upfront","component":"account_onboarding","future_requirements":"omit"},"reason_code":"requirements_past_due","reason_message":"Create a merchant account session to complete past-due merchant requirements.","required_fields":["components"],"required_scope":"merchants.account_sessions.write","url":"/v1/merchant-account-sessions"}],"status":"blocked","status_reason":"requirements_past_due"},"phone":"+14155552671","requirements":{"currently_due":[],"disabled_reason":"requirements_past_due","eventually_due":[],"past_due":["business_website"],"pending_verification":[]},"status":"active","support_email":"support@example.com","support_phone":"+14155552671","support_url":"https://example.com/support","updated_at":"2026-03-17T14:30:00Z","version":1,"website_url":"https://withflintpay.com"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/MerchantResponse"}}},"description":"The requested merchant.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"merchant not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Merchant not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get merchant","tags":["merchants"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["merchants.profile.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["merchants.profile.read","merchants.profile.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Applies a sparse update to the authenticated merchant's public business profile fields.","operationId":"updateMerchant","parameters":[{"description":"Flint merchant ID.","in":"path","name":"merchant_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"metadata":{"segment":"festivals"},"phone":"+14155550000","support_email":"help@example.com"},"schema":{"$ref":"#/components/schemas/UpdateMerchantRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"address":{"city":"New York","country":"US","line1":"123 Main St","postal_code":"10001","state":"NY"},"banners":[{"message":"Your account is ready to accept payments.","style":"success"}],"business_name":"Flint Events LLC","business_type":"company","created_at":"2026-03-17T14:30:00Z","email":"owner@example.com","has_past_due":false,"logo":{"alt":"Merchant logo","height":512,"url":"https://images.withflintpay.com/ia_merchant_logo/original","width":512},"merchant_id":"mer_123","metadata":{"segment":"events"},"observed_at":"2026-06-28T00:00:00Z","onboarding_status":"completed","payments":{"next_actions":[],"status":"ready","status_reason":null},"payouts":{"next_actions":[{"action_type":"create_merchant_account_session","merchant_account_session":{"collection_strategy":"upfront","component":"account_onboarding","future_requirements":"omit"},"reason_code":"requirements_past_due","reason_message":"Create a merchant account session to complete past-due merchant requirements.","required_fields":["components"],"required_scope":"merchants.account_sessions.write","url":"/v1/merchant-account-sessions"}],"status":"blocked","status_reason":"requirements_past_due"},"phone":"+14155552671","requirements":{"currently_due":[],"disabled_reason":"requirements_past_due","eventually_due":[],"past_due":["business_website"],"pending_verification":[]},"status":"active","support_email":"support@example.com","support_phone":"+14155552671","support_url":"https://example.com/support","updated_at":"2026-03-17T14:30:00Z","version":1,"website_url":"https://withflintpay.com"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/MerchantResponse"}}},"description":"The updated merchant.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"merchant not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Merchant not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"410":{"content":{"application/json":{"example":{"error":{"code":"API_VERSION_RETIRED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API version has retired. Choose a supported version.","param":"api_version","remediation":{"next_steps":"Set Flint-Version to a supported version listed in the error details.","retryable":false},"type":"invalid_request_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The API version has retired.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update merchant","tags":["merchants"],"x-flint-error-codes":["API_VERSION_RETIRED","AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_API_VERSION","INVALID_EXPECTED_VERSION","INVALID_REQUEST","MERCHANT_CHANGED","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["merchants.profile.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/modifier-groups":{"get":{"description":"List modifier groups.","operationId":"listModifierGroups","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by modifier group status.","in":"query","name":"status","required":false,"schema":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"}},{"description":"Filter by modifier group type.","in":"query","name":"modifier_group_type","required":false,"schema":{"enum":["list","text"],"type":"string","x-enum-descriptions":["List.","Text."],"x-flint-enum":"closed"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search across modifier group ID, external reference ID, name, and description.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"allow_quantities":false,"created_at":"2026-03-17T14:30:00Z","max_selected":1,"merchant_id":"mer_123","min_selected":1,"modifier_group_id":"mg_123","modifier_group_type":"list","modifiers":[{"modifier_group_id":"mg_123","modifier_id":"mod_123","name":"Whole milk","position":0,"selected_by_default":true,"show_on_fulfillment":true,"show_on_receipt":true,"status":"active"},{"modifier_group_id":"mg_123","modifier_id":"mod_456","name":"Oat milk","position":1,"selected_by_default":false,"show_on_fulfillment":true,"show_on_receipt":true,"status":"active","unit_price_delta_money":{"amount":75,"currency":"USD"}}],"name":"Milk","show_on_fulfillment":true,"show_on_receipt":true,"status":"active","updated_at":"2026-03-17T14:30:00Z","version":1}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ModifierGroupListResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List modifier groups","tags":["modifiers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.catalog.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.catalog.read","commerce.catalog.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Create modifier group.","operationId":"createModifierGroup","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{},"schema":{"$ref":"#/components/schemas/CreateModifierGroupRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"allow_quantities":false,"created_at":"2026-03-17T14:30:00Z","max_selected":1,"merchant_id":"mer_123","min_selected":1,"modifier_group_id":"mg_123","modifier_group_type":"list","modifiers":[{"modifier_group_id":"mg_123","modifier_id":"mod_123","name":"Whole milk","position":0,"selected_by_default":true,"show_on_fulfillment":true,"show_on_receipt":true,"status":"active"},{"modifier_group_id":"mg_123","modifier_id":"mod_456","name":"Oat milk","position":1,"selected_by_default":false,"show_on_fulfillment":true,"show_on_receipt":true,"status":"active","unit_price_delta_money":{"amount":75,"currency":"USD"}}],"name":"Milk","show_on_fulfillment":true,"show_on_receipt":true,"status":"active","updated_at":"2026-03-17T14:30:00Z","version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ModifierGroupResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create modifier group","tags":["modifiers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.catalog.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.catalog.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/modifier-groups/{modifier_group_id}":{"delete":{"description":"Retire modifier group.","operationId":"deleteModifierGroup","parameters":[{"description":"Flint modifier group ID.","in":"path","name":"modifier_group_id","required":true,"schema":{"type":"string"}},{"description":"Optional modifier group version last read by the caller.","in":"query","name":"expected_version","required":false,"schema":{"format":"uint64","minimum":1,"type":"integer"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"allow_quantities":false,"created_at":"2026-03-17T14:30:00Z","max_selected":1,"merchant_id":"mer_123","min_selected":1,"modifier_group_id":"mg_123","modifier_group_type":"list","modifiers":[{"modifier_group_id":"mg_123","modifier_id":"mod_123","name":"Whole milk","position":0,"selected_by_default":true,"show_on_fulfillment":true,"show_on_receipt":true,"status":"active"},{"modifier_group_id":"mg_123","modifier_id":"mod_456","name":"Oat milk","position":1,"selected_by_default":false,"show_on_fulfillment":true,"show_on_receipt":true,"status":"active","unit_price_delta_money":{"amount":75,"currency":"USD"}}],"name":"Milk","show_on_fulfillment":true,"show_on_receipt":true,"status":"archived","updated_at":"2026-03-17T14:30:00Z","version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ModifierGroupResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Retire modifier group","tags":["modifiers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.catalog.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.catalog.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Get modifier group.","operationId":"getModifierGroup","parameters":[{"description":"Flint modifier group ID.","in":"path","name":"modifier_group_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"allow_quantities":false,"created_at":"2026-03-17T14:30:00Z","max_selected":1,"merchant_id":"mer_123","min_selected":1,"modifier_group_id":"mg_123","modifier_group_type":"list","modifiers":[{"modifier_group_id":"mg_123","modifier_id":"mod_123","name":"Whole milk","position":0,"selected_by_default":true,"show_on_fulfillment":true,"show_on_receipt":true,"status":"active"},{"modifier_group_id":"mg_123","modifier_id":"mod_456","name":"Oat milk","position":1,"selected_by_default":false,"show_on_fulfillment":true,"show_on_receipt":true,"status":"active","unit_price_delta_money":{"amount":75,"currency":"USD"}}],"name":"Milk","show_on_fulfillment":true,"show_on_receipt":true,"status":"active","updated_at":"2026-03-17T14:30:00Z","version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ModifierGroupResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get modifier group","tags":["modifiers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.catalog.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.catalog.read","commerce.catalog.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Update modifier group.","operationId":"updateModifierGroup","parameters":[{"description":"Flint modifier group ID.","in":"path","name":"modifier_group_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{},"schema":{"$ref":"#/components/schemas/UpdateModifierGroupRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"allow_quantities":false,"created_at":"2026-03-17T14:30:00Z","max_selected":1,"merchant_id":"mer_123","min_selected":1,"modifier_group_id":"mg_123","modifier_group_type":"list","modifiers":[{"modifier_group_id":"mg_123","modifier_id":"mod_123","name":"Whole milk","position":0,"selected_by_default":true,"show_on_fulfillment":true,"show_on_receipt":true,"status":"active"},{"modifier_group_id":"mg_123","modifier_id":"mod_456","name":"Oat milk","position":1,"selected_by_default":false,"show_on_fulfillment":true,"show_on_receipt":true,"status":"active","unit_price_delta_money":{"amount":75,"currency":"USD"}}],"name":"Milk","show_on_fulfillment":true,"show_on_receipt":true,"status":"active","updated_at":"2026-03-17T14:30:00Z","version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ModifierGroupResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update modifier group","tags":["modifiers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.catalog.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.catalog.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/modifier-sets":{"get":{"description":"List modifier sets.","operationId":"listModifierSets","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by modifier set status.","in":"query","name":"status","required":false,"schema":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search across modifier set ID, external reference ID, name, and description.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ModifierSetListResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List modifier sets","tags":["modifiers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.catalog.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.catalog.read","commerce.catalog.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Create modifier set.","operationId":"createModifierSet","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{},"schema":{"$ref":"#/components/schemas/CreateModifierSetRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ModifierSetResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create modifier set","tags":["modifiers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.catalog.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.catalog.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/modifier-sets/{modifier_set_id}":{"delete":{"description":"Retire modifier set.","operationId":"deleteModifierSet","parameters":[{"description":"Flint modifier set ID.","in":"path","name":"modifier_set_id","required":true,"schema":{"type":"string"}},{"description":"Optional modifier set version last read by the caller.","in":"query","name":"expected_version","required":false,"schema":{"format":"uint64","minimum":1,"type":"integer"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ModifierSetResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Retire modifier set","tags":["modifiers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.catalog.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.catalog.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Get modifier set.","operationId":"getModifierSet","parameters":[{"description":"Flint modifier set ID.","in":"path","name":"modifier_set_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ModifierSetResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get modifier set","tags":["modifiers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.catalog.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.catalog.read","commerce.catalog.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Update modifier set.","operationId":"updateModifierSet","parameters":[{"description":"Flint modifier set ID.","in":"path","name":"modifier_set_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{},"schema":{"$ref":"#/components/schemas/UpdateModifierSetRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ModifierSetResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update modifier set","tags":["modifiers"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.catalog.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.catalog.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/oauth/authorize":{"get":{"description":"Authenticates the merchant in Flint, validates the requested partner app install, and redirects back to the partner's redirect_uri with an authorization code.","operationId":"authorizePartnerInstall","parameters":[{"description":"OAuth response type. Must be code.","in":"query","name":"response_type","required":true,"schema":{"enum":["code"],"type":"string","x-enum-descriptions":["Code."],"x-flint-enum":"closed"}},{"description":"Partner app client ID.","in":"query","name":"client_id","required":true,"schema":{"type":"string"}},{"description":"Registered redirect URI for the partner app.","in":"query","name":"redirect_uri","required":true,"schema":{"type":"string"}},{"description":"Install mode.","in":"query","name":"mode","required":true,"schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},{"description":"Optional comma-delimited permission IDs. When omitted, Flint uses the app's default requested permissions.","in":"query","name":"permission_ids","required":false,"schema":{"type":"string"}},{"description":"Optional explicit merchant environment ID. When omitted, Flint uses the merchant's default environment for the selected mode.","in":"query","name":"environment_id","required":false,"schema":{"type":"string"}},{"description":"Optional preferred merchant selection for multi-merchant users.","in":"query","name":"merchant_id","required":false,"schema":{"type":"string"}},{"description":"Opaque state value returned to the partner callback.","in":"query","name":"state","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"302":{"description":"Redirect to the partner callback URL with code and state query parameters.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]}],"summary":"Authorize partner install","tags":["partner_oauth"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported"}},"/v1/oauth/authorize/preview":{"get":{"description":"Validates the install link inputs and returns the partner app metadata and requested permissions for the consent screen.","operationId":"previewPartnerInstallAuthorization","parameters":[{"description":"Partner app client ID.","in":"query","name":"client_id","required":true,"schema":{"type":"string"}},{"description":"Registered redirect URI for the partner app.","in":"query","name":"redirect_uri","required":true,"schema":{"type":"string"}},{"description":"Install mode.","in":"query","name":"mode","required":true,"schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},{"description":"Optional comma-delimited permission IDs. When omitted, Flint uses the app's default requested permissions.","in":"query","name":"permission_ids","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"app_type":"plugin","client_id":"fpc_1234567890abcdef1234567890abcd","mode":"test","name":"Acme Commerce Plugin","partner_app_id":"papp_01JQPARTNERAPP1234567890","redirect_uri":"https://plugins.acme.com/flint/oauth/callback","requested_permission_ids":["manage_orders","read_catalog"],"requested_permissions":[{"description":"Read and update Flint orders for installed merchants.","permission_id":"manage_orders","title":"Manage orders"},{"description":"Read product, variant, bundle, and SKU lookup catalog records.","optional":true,"permission_id":"read_catalog","title":"Read catalog"}]},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PartnerAuthorizePreviewResponse"}}},"description":"The validated install preview.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Partner app not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[],"summary":"Preview partner install","tags":["partner_oauth"],"x-flint-error-codes":["INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported"}},"/v1/oauth/contexts":{"post":{"description":"First-party public client flint-cli. Uses application/x-www-form-urlencoded and flat OAuth JSON without a Flint envelope. No client secret or HTTP Basic authentication. Requests are not replayed through idempotency caching. Flint session control extension. Authenticates the current refresh token without consuming or rotating it. Returns only currently authorized contexts, including an empty list. Read approved scopes from the selected context's token response or /v1/developer/auth-context. No business access is granted.","operationId":"listCLIContexts","parameters":[{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/CLIContextsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":null,"schema":{"$ref":"#/components/schemas/CLIContextsResponse"}}},"description":"OAuth response. Credential responses include Cache-Control: no-store and Pragma: no-cache.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":"invalid_request"},"schema":{"$ref":"#/components/schemas/PartnerTokenErrorResponse"}}},"description":"OAuth request error.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":"temporarily_unavailable"},"schema":{"$ref":"#/components/schemas/PartnerTokenErrorResponse"}}},"description":"Authorization is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[],"summary":"List authorized CLI contexts","tags":["cli_oauth"],"x-flint-error-codes":["INVALID_REQUEST","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported"}},"/v1/oauth/device/authorize":{"post":{"description":"First-party public client flint-cli. Uses application/x-www-form-urlencoded and flat OAuth JSON without a Flint envelope. No client secret or HTTP Basic authentication. Requests are not replayed through idempotency caching. Send session_mode=contexts for a session that supports additive reauthorization. The required scope field contains the full requested set as space-separated names. Normal login sends the unchanged x-flint-cli-bootstrap-scopes; login with extra permissions sends the desired baseline and additions. No scopes are implicitly added. The browser may approve a subset per context; token scope reports the approved set. Unknown scopes return HTTP 400 invalid_scope. Selected scopes are checked against the selected merchant and environment before approval.","operationId":"authorizeCLIDevice","parameters":[{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/CLIDeviceRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":null,"schema":{"$ref":"#/components/schemas/CLIDeviceResponse"}}},"description":"OAuth response. Credential responses include Cache-Control: no-store and Pragma: no-cache.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":"invalid_request"},"schema":{"$ref":"#/components/schemas/PartnerTokenErrorResponse"}}},"description":"OAuth request error.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":"temporarily_unavailable"},"schema":{"$ref":"#/components/schemas/PartnerTokenErrorResponse"}}},"description":"Authorization is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[],"summary":"Start CLI browser login","tags":["cli_oauth"],"x-flint-error-codes":["INVALID_REQUEST","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported"}},"/v1/oauth/device/reauthorize":{"post":{"description":"First-party public client flint-cli. Uses application/x-www-form-urlencoded and flat OAuth JSON without a Flint envelope. No client secret or HTTP Basic authentication. Requests are not replayed through idempotency caching. Flint session control extension. Starts device consent bound to the current session and user without consuming the refresh token. Without scope_mode, approval replaces consent; denial or expiry leaves consent unchanged. Redeem using the device_code grant to rotate the latest family token. Set scope_mode=additive and context_id to request additional space-separated scope names for one existing context. Merchant and environment are derived from that context; conflicting hints return invalid_context. Approval unions only browser-approved additions with that context's existing scopes and preserves all other contexts. No implicit bootstrap scopes are added. Unsupported or environment-disallowed scopes return HTTP 400 invalid_scope; browser denial returns access_denied when polling. Partial approval succeeds and scope in the token response is authoritative. Legacy single-context sessions must start a new contexts-mode authorization.","operationId":"reauthorizeCLIDevice","parameters":[{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/CLIReauthorizeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":null,"schema":{"$ref":"#/components/schemas/CLIDeviceResponse"}}},"description":"OAuth response. Credential responses include Cache-Control: no-store and Pragma: no-cache.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":"invalid_request"},"schema":{"$ref":"#/components/schemas/PartnerTokenErrorResponse"}}},"description":"OAuth request error.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":"temporarily_unavailable"},"schema":{"$ref":"#/components/schemas/PartnerTokenErrorResponse"}}},"description":"Authorization is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[],"summary":"Review CLI session consent","tags":["cli_oauth"],"x-flint-error-codes":["INVALID_REQUEST","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported"}},"/v1/oauth/revoke":{"post":{"description":"First-party public client flint-cli. Uses application/x-www-form-urlencoded and flat OAuth JSON without a Flint envelope. No client secret or HTTP Basic authentication. Requests are not replayed through idempotency caching.","operationId":"revokeCLIGrant","parameters":[{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/CLIRevokeRequest"}}},"required":true},"responses":{"200":{"description":"The grant was revoked, or the token was already invalid. The body is empty.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":"invalid_request"},"schema":{"$ref":"#/components/schemas/PartnerTokenErrorResponse"}}},"description":"OAuth request error.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":"temporarily_unavailable"},"schema":{"$ref":"#/components/schemas/PartnerTokenErrorResponse"}}},"description":"Authorization is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[],"summary":"Revoke a CLI session","tags":["cli_oauth"],"x-flint-error-codes":["INVALID_REQUEST","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported"}},"/v1/oauth/token":{"post":{"description":"Exchanges an authorization code or refresh token for an installation-scoped bearer token. This endpoint follows OAuth token endpoint conventions: it accepts application/x-www-form-urlencoded requests as well as JSON and returns OAuth token error objects for token exchange failures instead of the normal Flint error envelope. The public client flint-cli also supports the RFC 8628 device_code grant and rotating refresh tokens using form requests. Pending device requests return authorization_pending; early polling returns slow_down and increases the required interval by five seconds; denial returns access_denied; expired or consumed codes return expired_token. Access tokens last 15 minutes. CLI sessions expire after 30 days idle or 90 days total. Reusing a rotated refresh token revokes its family, including when the previous response was lost. A fresh browser login is then required. With session_mode=contexts at authorization, tokens include oauth_session_id and context_id. Refresh requires an explicitly authorized context_id; invalid_context and context_access_denied do not consume the refresh token. Each access token is limited to one context. Ordinary rotation preserves other unexpired access tokens; removing consent immediately invalidates affected tokens. Legacy sessions retain their original response and authorization semantics.","operationId":"exchangePartnerInstallToken","parameters":[{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"client_id":"fpc_1234567890abcdef1234567890abcd","client_secret":"fps_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcd","code":"fpac_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcd","grant_type":"authorization_code","redirect_uri":"https://plugins.acme.com/flint/oauth/callback"},"schema":{"$ref":"#/components/schemas/PartnerTokenRequest"}},"application/x-www-form-urlencoded":{"schema":{"anyOf":[{"$ref":"#/components/schemas/PartnerTokenRequest"},{"$ref":"#/components/schemas/CLITokenRequest"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"access_token":"fpat_v1.c2FtcGxlLXBhcnRuZXItaW5zdGFsbC10b2tlbg","environment_grant_id":"egrt_01JQPARTNERGRANT12345678","expires_in":3600,"merchant_id":"mer_123","mode":"test","partner_app_id":"papp_01JQPARTNERAPP1234567890","partner_app_install_id":"pinst_01JQPARTNERINSTALL123456","refresh_token":"fprt_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcd","scope":"commerce.orders.read commerce.orders.write","token_type":"bearer"},"schema":{"anyOf":[{"$ref":"#/components/schemas/PartnerTokenResponse"},{"$ref":"#/components/schemas/CLITokenResponse"}]}}},"description":"The installation-scoped access token and refresh token.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":"invalid_grant","error_description":"The authorization grant is invalid."},"schema":{"$ref":"#/components/schemas/PartnerTokenErrorResponse"}}},"description":"The token request was invalid.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":"invalid_client","error_description":"Client authentication failed."},"schema":{"$ref":"#/components/schemas/PartnerTokenErrorResponse"}}},"description":"Client authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":"temporarily_unavailable","error_description":"The token service is temporarily unavailable."},"schema":{"$ref":"#/components/schemas/PartnerTokenErrorResponse"}}},"description":"Partner OAuth is unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[],"summary":"Exchange an OAuth token","tags":["partner_oauth"],"x-flint-error-codes":["AUTH_REQUIRED","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported"}},"/v1/onboarding/advance":{"post":{"description":"Submits whatever the caller currently knows, re-evaluates onboarding, reconciles onboarding requirements, and returns the next step in the consolidated onboarding state machine. Send an empty JSON object when the current next_step only asks to refresh onboarding requirements.","operationId":"advanceOnboarding","parameters":[{"description":"Optional sandbox to bind when advancing test-mode onboarding. The returned next_step.submit_endpoint includes this parameter when needed.","in":"query","name":"sandbox_id","required":false,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"country":"US","profile":{"support_email":"help@example.com","website_url":"https://withflintpay.com"},"requested_capabilities":["accept_card_payments","receive_payouts"]},"schema":{"$ref":"#/components/schemas/OnboardingAdvanceRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"can_issue_api_key":true,"country":"US","default_sandbox_id":"test_01JQEXAMPLEDEFAULT12345678","email_verified":true,"merchant_created":true,"merchant_id":"mer_123","next_step":{"code":"complete_verification_step","launch":{"component":"account_onboarding","endpoint":"/v1/merchant-account-sessions","method":"POST","recommended_policy":{"collection_strategy":"upfront","future_requirements":"include"},"sandbox_id":"test_01JQEXAMPLEDEFAULT12345678"},"machine_completable":false,"owner":"human"},"profile":{"email":"owner@example.com","support_email":"help@example.com","support_phone":"+14155552671","support_url":"https://example.com/support","website_url":"https://withflintpay.com"},"requested_capabilities":["accept_card_payments","receive_payouts"],"requirements":{"current_deadline_at":"2026-04-01T00:00:00Z","currently_due":["merchant_category_code","business_website"],"eventually_due":["representative_first_name"]},"status":"needs_external_action"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OnboardingStateResponse"}}},"description":"The updated onboarding state.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"examples":{"invalid_country":{"summary":"Invalid country","value":{"error":{"code":"INVALID_COUNTRY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"country must be an ISO 3166-1 alpha-2 country code using uppercase letters.","param":"country","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}},"unsupported_country":{"summary":"Unsupported onboarding country","value":{"error":{"code":"COUNTRY_NOT_SUPPORTED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Flint onboarding is not available for this business country.","param":"country","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}},"validation":{"summary":"Validation error","value":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid onboarding data.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Onboarding session or API key required.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"ACCOUNT_SETUP_CONFIGURATION_CONFLICT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Account setup cannot continue because its stored provisioning configuration is not supported. Contact Flint support before retrying.","remediation":{"next_steps":"Contact Flint support to repair the account setup configuration before retrying.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The stored account setup configuration cannot be resumed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Onboarding is unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"OnboardingSessionBearer":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Advance onboarding flow","tags":["onboarding"],"x-flint-error-codes":["ACCOUNT_SETUP_CONFIGURATION_CONFLICT","AUTH_REQUIRED","COUNTRY_NOT_SUPPORTED","INVALID_API_KEY","INVALID_COUNTRY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["merchants.onboarding.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/onboarding/api-key":{"post":{"description":"Creates the first long-lived external API key and exits onboarding.","operationId":"createOnboardingAPIKey","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"name":"First backend integration","scopes":["commerce.orders.read","commerce.orders.write","customers.read","customers.write"]},"schema":{"$ref":"#/components/schemas/DeveloperInitialAPIKeyRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"api_key_id":"key_123","created_at":"2026-03-17T14:30:00Z","expires_at":"2027-03-17T14:30:00Z","key_prefix":"flint_test_abcd1234","key_type":"external","last_used_at":"2026-03-17T15:00:00Z","merchant_id":"mer_123","name":"Sandbox orders integration","sandbox_id":"test_01JQEXAMPLEDEFAULT12345678","scopes":["accounts.api_keys.read","accounts.api_keys.write","commerce.orders.read","commerce.orders.write"],"secret_key":"flint_test_0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef","status":"active","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CreateAPIKeyResponse"}}},"description":"The created external API key. secret_key is only returned once.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Onboarding session required.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"OnboardingSessionBearer":[]}],"summary":"Create onboarding API key","tags":["onboarding"],"x-flint-error-codes":["AUTH_REQUIRED","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-route-class":"sensitive_write"}},"/v1/onboarding/start":{"post":{"description":"Starts the consolidated onboarding flow by emailing a short-lived verification code and returning a temporary verification token.","operationId":"startOnboarding","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Checkout session ID when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"email":"owner@example.com","first_name":"Jane","last_name":"Doe"},"schema":{"$ref":"#/components/schemas/OnboardingStartRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"expires_at":"2026-03-18T20:00:00Z","verification_started":true,"verification_token":"devver_v1.c2FtcGxlLXZlcmlmaWNhdGlvbi10b2tlbg"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OnboardingStartResponse"}}},"description":"The verification challenge metadata.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Onboarding is unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[],"summary":"Start onboarding flow","tags":["onboarding"],"x-flint-error-codes":["INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"sensitive_write"}},"/v1/onboarding/state":{"get":{"description":"Returns the consolidated onboarding state machine, including the primary next step for agents or humans. This endpoint is read-only.","operationId":"getOnboardingState","parameters":[{"description":"Optional sandbox to bind when evaluating test-mode onboarding.","in":"query","name":"sandbox_id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"can_issue_api_key":true,"country":"US","default_sandbox_id":"test_01JQEXAMPLEDEFAULT12345678","email_verified":true,"merchant_created":true,"merchant_id":"mer_123","next_step":{"code":"complete_verification_step","launch":{"component":"account_onboarding","endpoint":"/v1/merchant-account-sessions","method":"POST","recommended_policy":{"collection_strategy":"upfront","future_requirements":"include"},"sandbox_id":"test_01JQEXAMPLEDEFAULT12345678"},"machine_completable":false,"owner":"human"},"profile":{"email":"owner@example.com","support_email":"help@example.com","support_phone":"+14155552671","support_url":"https://example.com/support","website_url":"https://withflintpay.com"},"requested_capabilities":["accept_card_payments","receive_payouts"],"requirements":{"current_deadline_at":"2026-04-01T00:00:00Z","currently_due":["merchant_category_code","business_website"],"eventually_due":["representative_first_name"]},"status":"needs_external_action"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OnboardingStateResponse"}}},"description":"The current onboarding state.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Onboarding session or API key required.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Onboarding is unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"OnboardingSessionBearer":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get onboarding state","tags":["onboarding"],"x-flint-error-codes":["AUTH_REQUIRED","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["merchants.onboarding.read","merchants.onboarding.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/onboarding/verify-email":{"post":{"description":"Verifies the emailed code, provisions the Flint user and merchant if needed, and returns a short-lived session token for the rest of onboarding.","operationId":"verifyOnboardingEmail","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"verification_code":"482193","verification_token":"devver_v1.c2FtcGxlLXZlcmlmaWNhdGlvbi10b2tlbg"},"schema":{"$ref":"#/components/schemas/OnboardingVerifyEmailRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"can_issue_api_key":true,"default_sandbox_id":"test_01JQEXAMPLEDEFAULT12345678","merchant":{"address":{"city":"New York","country":"US","line1":"123 Main St","postal_code":"10001","state":"NY"},"banners":[{"message":"Your account is ready to accept payments.","style":"success"}],"business_name":"Flint Events LLC","business_type":"company","created_at":"2026-03-17T14:30:00Z","email":"owner@example.com","has_past_due":false,"logo":{"alt":"Merchant logo","height":512,"url":"https://images.withflintpay.com/ia_merchant_logo/original","width":512},"merchant_id":"mer_123","metadata":{"segment":"events"},"observed_at":"2026-06-28T00:00:00Z","onboarding_status":"completed","payments":{"next_actions":[],"status":"ready","status_reason":null},"payouts":{"next_actions":[{"action_type":"create_merchant_account_session","merchant_account_session":{"collection_strategy":"upfront","component":"account_onboarding","future_requirements":"omit"},"reason_code":"requirements_past_due","reason_message":"Create a merchant account session to complete past-due merchant requirements.","required_fields":["components"],"required_scope":"merchants.account_sessions.write","url":"/v1/merchant-account-sessions"}],"status":"blocked","status_reason":"requirements_past_due"},"phone":"+14155552671","requirements":{"currently_due":[],"disabled_reason":"requirements_past_due","eventually_due":[],"past_due":["business_website"],"pending_verification":[]},"status":"active","support_email":"support@example.com","support_phone":"+14155552671","support_url":"https://example.com/support","updated_at":"2026-03-17T14:30:00Z","version":1,"website_url":"https://withflintpay.com"},"merchant_created":true,"next_step":{"code":"check_onboarding_state","machine_completable":true,"owner":"agent","submit_endpoint":"/v1/onboarding/state","submit_method":"GET"},"onboarding_session_token":"devsess_v1.c2FtcGxlLWRldmVsb3Blci1zZXNzaW9uLXRva2Vu","status":"merchant_ready","user":{"created_at":"2026-03-18T19:45:00Z","default_merchant_id":"mer_123","email":"owner@example.com","first_name":"Jane","last_name":"Doe","status":"active","updated_at":"2026-03-18T19:45:00Z","user_id":"usr_123"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OnboardingVerifyEmailResponse"}}},"description":"The verified onboarding session.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Verification failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Onboarding is unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[],"summary":"Verify onboarding email","tags":["onboarding"],"x-flint-error-codes":["AUTH_REQUIRED","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"sensitive_write"}},"/v1/openapi.json":{"get":{"description":"Returns the Flint public OpenAPI document for tooling, schema inspection, and client generation.","operationId":"getOpenAPISpec","parameters":[{"description":"API version in YYYY-MM-DD format. Overrides Flint-Version for the returned specification.","in":"query","name":"version","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"OpenAPI document","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_VERSION","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"version must identify a supported API version","param":"version","remediation":{"next_steps":"Set Flint-Version to a supported version listed in the error details.","retryable":false},"type":"invalid_request_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid API version.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"410":{"content":{"application/json":{"example":{"error":{"code":"API_VERSION_RETIRED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"version must identify a supported API version","param":"version","remediation":{"next_steps":"Set Flint-Version to a supported version listed in the error details.","retryable":false},"type":"invalid_request_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The API version has retired.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[],"summary":"Get OpenAPI spec","tags":["meta"],"x-flint-error-codes":["API_VERSION_RETIRED","INVALID_API_VERSION","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported"}},"/v1/orders":{"get":{"description":"Returns a paginated list of orders for the authenticated merchant.","operationId":"listOrders","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by customer ID.","in":"query","name":"customer_id","required":false,"schema":{"type":"string"}},{"description":"Filter by workflow status.","in":"query","name":"status","required":false,"schema":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},{"description":"Filter by settled collection status.","in":"query","name":"payment_status","required":false,"schema":{"enum":["unpaid","partially_paid","paid"],"type":"string","x-enum-descriptions":["Unpaid.","Partially paid.","Paid."],"x-flint-enum":"open"}},{"description":"Filter by refund progress.","in":"query","name":"refund_status","required":false,"schema":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"}},{"description":"Filter by aggregate order fulfillment status. Repeat the parameter to OR multiple statuses.","explode":true,"in":"query","name":"fulfillment_status","required":false,"schema":{"items":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"Filter by merchant-visible order number.","in":"query","name":"order_number","required":false,"schema":{"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Filter by order origin.","in":"query","name":"origin","required":false,"schema":{"enum":["virtual_terminal","payment_link","checkout","api","subscription"],"type":"string","x-enum-descriptions":["Virtual terminal.","Payment link.","Checkout.","Api.","Subscription."],"x-flint-enum":"closed"}},{"description":"Search across order number, external_reference_id, fulfillment external_reference_id, notes, and line item names.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Filter by subscription ID.","in":"query","name":"subscription_id","required":false,"schema":{"type":"string"}},{"description":"Filter by the Return that created a replacement order.","in":"query","name":"return_id","required":false,"schema":{"type":"string"}},{"description":"Filter by the ReturnResolution that created a replacement order.","in":"query","name":"return_resolution_id","required":false,"schema":{"type":"string"}},{"description":"Inclusive lower bound on the order total in minor units. Requires currency.","in":"query","name":"min_amount","required":false,"schema":{"example":500,"format":"int64","minimum":1,"type":"integer"}},{"description":"Inclusive upper bound on the order total in minor units. Requires currency.","in":"query","name":"max_amount","required":false,"schema":{"example":500,"format":"int64","minimum":1,"type":"integer"}},{"description":"ISO 4217 currency for min_amount and max_amount.","in":"query","name":"currency","required":false,"schema":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["created_at","updated_at","outstanding_money","total"],"type":"string","x-enum-descriptions":["Created at.","Updated at.","Outstanding money.","Total."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"RFC3339 lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 lower bound for updated_at.","in":"query","name":"updated_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for updated_at.","in":"query","name":"updated_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderListResponse"}}},"description":"A page of orders.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List orders","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.read","commerce.orders.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates an order for the authenticated merchant. For USD orders, an effective requested tip may be up to the larger of $1,000 or 100% of the post-discount merchandise subtotal.","operationId":"createOrder","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Checkout session ID when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"discounts":[{"manual":{"amount_money":{"amount":500,"currency":"USD"},"name":"Launch credit"}}],"line_items":[{"metadata":{"ticket_type":"ga"},"name":"General Admission","quantity":2,"unit_price_money":{"amount":2500,"currency":"USD"}}],"metadata":{"event_id":"evt_123"}},"schema":{"$ref":"#/components/schemas/CreateOrderRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"The created order.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create order","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","AUTOMATIC_TAX_COMPONENTS_FORBIDDEN","AUTOMATIC_TAX_EXEMPTION_UNSUPPORTED","AUTOMATIC_TAX_MULTIPLE_DESTINATIONS","AUTOMATIC_TAX_MULTIPLE_ORIGINS","AUTOMATIC_TAX_POST_TAX_DISCOUNT_UNSUPPORTED","BUNDLE_NOT_SELLABLE","CATALOG_INVENTORY_RELATIONSHIP_INVALID","CATALOG_LINE_ITEM_CURRENCY_CHANGED","CATALOG_LINE_ITEM_FIELDS_READ_ONLY","CATALOG_LINE_ITEM_SOURCE_CHANGED","CHECKOUT_TAX_CALCULATION_LIMIT_REACHED","CREATE_ORDER_LINE_ITEM_DISCOUNT_UNSUPPORTED","CURRENCY_MISMATCH","DELIVERY_DESTINATION_ADDRESS_INCOMPLETE","DELIVERY_DESTINATION_ADDRESS_REQUIRED","DELIVERY_DESTINATION_COUNTRY_INVALID","DELIVERY_DESTINATION_FIELD_TOO_LONG","DELIVERY_DESTINATION_NOT_APPLICABLE","DISCOUNT_AMOUNT_INVALID","DUPLICATE_ORDER_CHARGE_ID","DUPLICATE_TAX_COMPONENT","EXTERNAL_IMAGE_NOT_ALLOWED","EXTERNAL_TAX_COMPONENTS_REQUIRED","FIELD_REQUIRED","FLAT_TAX_PRICE_MODE_INVALID","FLAT_TAX_SCOPE_INVALID","FULFILLMENT_BUNDLE_UNSUPPORTED","FULFILLMENT_CONFIGURATION_ACTION_REQUIRED","FULFILLMENT_PROFILE_REVISION_UNUSABLE","FULFILLMENT_REQUIREMENT_REQUIRED","IDEMPOTENCY_CLEAR_FAILED","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","IDEMPOTENCY_LOAD_FAILED","IDEMPOTENCY_PERSIST_FAILED","IDEMPOTENCY_RECORD_INVALID","IDEMPOTENCY_RECOVERY_REQUIRED","IMAGE_ASSET_NOT_ATTACHABLE","IMAGE_ASSET_NOT_FOUND","IMAGE_URL_INVALID","IMAGE_URL_MUST_BE_CANONICAL","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_CURRENCY","INVALID_DISCOUNT","INVALID_DISCOUNT_CLASS","INVALID_DISCOUNT_SCOPE","INVALID_FIELD_TYPE","INVALID_FLAT_TAX","INVALID_FULFILLMENT_REQUIREMENT","INVALID_ID","INVALID_IDEMPOTENCY_KEY","INVALID_IMAGE_ALT","INVALID_LINE_ITEMS","INVALID_METADATA_KEY","INVALID_REQUEST","INVALID_TAX_CALCULATION_TYPE","INVALID_TAX_CATEGORY","INVALID_TAX_JURISDICTION","INVALID_TAX_MODE","INVALID_TAX_PERCENTAGE","INVALID_TAX_PRICE_MODE","INVALID_TAX_TYPE","INVALID_TIP","INVALID_TIP_AMOUNT","INVALID_TIP_PERCENT","INVALID_TOTALS","INVENTORY_DEMAND_DUPLICATE","INVENTORY_DEMAND_INVALID","INVENTORY_ROUTING_SOURCE_INVALID","INVENTORY_ROUTING_SOURCE_REQUIRED","LINE_ITEM_INVALID_QUANTITY","LINE_ITEM_NAME_REQUIRED","LINE_ITEM_NAME_TOO_LONG","LINE_ITEM_NEGATIVE_PRICE","LINE_ITEM_PRICE_REQUIRED","LINE_ITEM_QUANTITY_TOO_LARGE","LINE_ITEM_SOURCE_CONFLICT","LINE_ITEM_UNIT_PRICE_REQUIRED","METADATA_KEY_TOO_LONG","METADATA_TOO_LARGE","METADATA_TOO_MANY_KEYS","METADATA_VALUE_TOO_LONG","MISSING_LINE_ITEMS","MODIFIER_CURRENCY_MISMATCH","MODIFIER_DUPLICATE_SELECTION","MODIFIER_GROUP_REQUIRED","MODIFIER_QUANTITY_INVALID","MODIFIER_SELECTION_LIMIT_EXCEEDED","MODIFIER_SOURCE_UNSUPPORTED","MODIFIER_TEXT_INVALID","MODIFIER_UNAVAILABLE","NOTE_TOO_LONG","NO_DISCOUNTABLE_BALANCE","NULL_NOT_ALLOWED","ORDER_CHARGE_NOT_FOUND","ORDER_CHARGE_TAX_INPUT_REQUIRED","ORDER_DISCOUNT_NO_CHARGE_IDS","ORDER_DISCOUNT_NO_LINE_ITEM_IDS","ORDER_LINE_ITEM_TAX_INPUT_REQUIRED","ORDER_PERCENTAGE_TAX_FORBIDDEN","ORDER_TAX_CALCULATION_FAILED","ORDER_TAX_LOCATION_INVALID","ORDER_TAX_RATE_UNAVAILABLE","ORDER_TAX_UNSUPPORTED_COUNTRY","PRODUCT_LINE_ITEM_SOURCE_UNSUPPORTED","PROMOTION_CONFLICT","PROMOTION_DECLINED","PROMOTION_ID_REQUIRED","PROMOTION_NOT_REDEEMABLE","PROMOTION_NO_ACTIVE_CODES","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESERVED_METADATA_KEY","RESOURCE_NOT_FOUND","SERVICE_CHARGE_DISCOUNT_NO_LINE_ITEM_IDS","SERVICE_CHARGE_DISCOUNT_REQUIRES_CHARGE_IDS","SERVICE_CHARGE_DISCOUNT_SCOPE_INVALID","SERVICE_UNAVAILABLE","TAX_CALCULATION_REQUIRED","TAX_INPUT_CONFLICT","TAX_MODE_MISMATCH","TIP_CURRENCY_MISMATCH","TIP_LIMIT_EXCEEDED","TOO_MANY_LINE_ITEMS","UNKNOWN_FIELD","UNSUPPORTED_CURRENCY","VARIANT_NOT_SELLABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/orders/{order_id}":{"get":{"description":"Returns a single order by ID.","operationId":"getOrder","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Checkout session ID for buyer-facing checkout authentication.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret for buyer-facing checkout authentication.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"Supported expansions: customer, fulfillments.packages, fulfillments.shipments, payment_intents, subscription, subscription_plan. Expansion requires the base order read scope plus the read scope for each expanded resource. Limits: at most 10 unique expand paths per request; path depth at most 2. To-many expansions are capped at 20 related objects per path. Repeat expand, for example expand=customer\u0026expand=fulfillments.packages, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["customer","fulfillments.packages","fulfillments.shipments","payment_intents","subscription","subscription_plan"],"type":"string","x-enum-descriptions":["Customer.","Fulfillments.packages.","Fulfillments.shipments.","Payment intents.","Subscription.","Subscription plan."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Order","value":{"data":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Order with expanded relationships","value":{"data":{"created_at":"2026-03-17T14:30:00Z","customer":{"created_at":"2026-03-16T12:00:00Z","customer_id":"cus_123","email":"buyer@example.com","name":"Avery Buyer","updated_at":"2026-03-17T14:00:00Z"},"customer_id":"cus_123","fulfillments":[{"fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","line_items":[],"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","packages":[{"carrier":"ups","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","service_code":"ground","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"created","supported_actions":null,"tracking_number":"1Z999AA10123456784","tracking_url":"https://track.example.com/1Z999AA10123456784","version":0}],"request_status":"","shipments":[{"direction":"outbound","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","package_count":0,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"created"}],"status":"in_progress","supported_actions":null,"type":"shipment","version":0}],"line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_intent_ids":["pi_123"],"payment_intents":[{"amount_money":{"amount":5000,"currency":"USD"},"capture_method":"automatic","created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","order_id":"ord_123","payment_intent_id":"pi_123","payment_source":{"card":{"brand":"visa","last4":"4242"},"type":"card"},"refund_status":"none","status":"requires_confirmation","updated_at":"2026-03-17T14:30:00Z"}],"payment_status":"unpaid","plan_id":"plan_123","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","subscription":{"billing_anchor_day":15,"cancel_at_period_end":false,"created_at":"2026-03-17T14:30:00Z","current_period_end":"2026-04-17T14:30:00Z","current_period_start":"2026-03-17T14:30:00Z","customer_id":"cus_123","next_billing_at":"2026-04-17T14:30:00Z","plan_id":"plan_123","status":"active","subscription_id":"sub_123","updated_at":"2026-03-17T14:30:00Z"},"subscription_id":"sub_123","subscription_plan":{"billing_interval":"monthly","billing_interval_count":1,"created_at":"2026-03-17T14:30:00Z","currency":"USD","line_items":[{"name":"Membership","quantity":1,"subscription_plan_line_item_id":"spli_123","unit_price_money":{"amount":2500,"currency":"USD"}}],"name":"Monthly Membership","plan_id":"plan_123","status":"active","updated_at":"2026-03-17T14:30:00Z"},"tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"The requested order.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"examples":{"invalid_expand":{"summary":"Unsupported expand path","value":{"error":{"code":"INVALID_EXPAND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Unknown expand path \"card\" for GET /v1/orders/{order_id}. Supported values: customer, fulfillments.packages, fulfillments.shipments, payment_intents, subscription, subscription_plan.","param":"expand","remediation":{"next_steps":"Fix or remove the requested expand path; use only supported values documented for the route.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}},"validation":{"summary":"Validation error","value":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get order","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_EXPAND","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.read","commerce.orders.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Applies a sparse update to mutable order fields such as customer_id, notes, metadata, tax, the delivery destination, and the requested tip. Send requested_tip: null to clear the current requested tip.","operationId":"updateOrder","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Checkout session ID when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"buyer_note":"Please include a gift receipt.","internal_note":"VIP hold","metadata":{"priority":"vip"},"requested_tip":{"percent":18}},"schema":{"$ref":"#/components/schemas/UpdateOrderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"The updated order.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update order","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","AUTOMATIC_TAX_COMPONENTS_FORBIDDEN","AUTOMATIC_TAX_EXEMPTION_UNSUPPORTED","AUTOMATIC_TAX_MULTIPLE_DESTINATIONS","AUTOMATIC_TAX_MULTIPLE_ORIGINS","AUTOMATIC_TAX_POST_TAX_DISCOUNT_UNSUPPORTED","CHECKOUT_ORDER_UPDATE_FIELD_NOT_ALLOWED","CHECKOUT_PAYMENT_RESOLVING","CHECKOUT_TAX_CALCULATION_LIMIT_REACHED","CHECKOUT_TIPPING_DISABLED","CHECKOUT_TIP_NOT_ALLOWED","DELIVERY_DESTINATION_ADDRESS_INCOMPLETE","DELIVERY_DESTINATION_ADDRESS_REQUIRED","DELIVERY_DESTINATION_CONTROLLED_BY_SELECTION","DELIVERY_DESTINATION_COUNTRY_INVALID","DELIVERY_DESTINATION_FIELD_TOO_LONG","DELIVERY_DESTINATION_FROZEN","DELIVERY_DESTINATION_NOT_APPLICABLE","DELIVERY_DESTINATION_UPDATE_CONFLICT","DUPLICATE_TAX_COMPONENT","EXTERNAL_TAX_COMPONENTS_REQUIRED","FIELD_REQUIRED","FLAT_TAX_PRICE_MODE_INVALID","IDEMPOTENCY_CLEAR_FAILED","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","IDEMPOTENCY_LOAD_FAILED","IDEMPOTENCY_PERSIST_FAILED","IDEMPOTENCY_RECORD_INVALID","IDEMPOTENCY_RECOVERY_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_FIELD_TYPE","INVALID_FLAT_TAX","INVALID_ID","INVALID_IDEMPOTENCY_KEY","INVALID_METADATA_KEY","INVALID_ORDER_STATUS","INVALID_REQUEST","INVALID_TAX_CALCULATION_TYPE","INVALID_TAX_CATEGORY","INVALID_TAX_JURISDICTION","INVALID_TAX_MODE","INVALID_TAX_PRICE_MODE","INVALID_TAX_TYPE","INVALID_TIP","INVALID_TIP_AMOUNT","INVALID_TIP_PERCENT","INVALID_TOTALS","INVENTORY_RESERVATION_EXISTS","INVENTORY_ROUTING_SOURCE_INVALID","INVENTORY_ROUTING_SOURCE_REQUIRED","INVOICE_LOCKED_ORDER_FINANCIALS","METADATA_KEY_TOO_LONG","METADATA_TOO_LARGE","METADATA_TOO_MANY_KEYS","METADATA_VALUE_TOO_LONG","NOTE_TOO_LONG","NO_FIELDS_TO_UPDATE","NULL_NOT_ALLOWED","ORDER_CHARGE_TAX_INPUT_REQUIRED","ORDER_CLOSED","ORDER_COLLECTION_ALREADY_ACTIVE","ORDER_CONFLICT","ORDER_CUSTOMER_ALREADY_SET","ORDER_CUSTOMER_CHECKOUT_ACTIVE","ORDER_CUSTOMER_NOT_CLEARABLE","ORDER_CUSTOMER_NOT_UPDATABLE_AFTER_PAYMENT","ORDER_FINANCIAL_MUTATION_NOT_ALLOWED","ORDER_LINE_ITEM_TAX_INPUT_REQUIRED","ORDER_PERCENTAGE_TAX_FORBIDDEN","ORDER_TAX_CALCULATION_FAILED","ORDER_TAX_LOCATION_INVALID","ORDER_TAX_NOT_UPDATABLE_AFTER_PAYMENT","ORDER_TAX_RATE_UNAVAILABLE","ORDER_TAX_UNSUPPORTED_COUNTRY","ORDER_TIP_MODEL_UNSUPPORTED","ORDER_TOTAL_BELOW_NET_COLLECTED","PAYMENT_ATTEMPT_FROZEN","PAYMENT_ATTEMPT_IN_PROGRESS","PAYMENT_ATTEMPT_STILL_PROCESSING","PRODUCT_LINE_ITEM_SOURCE_UNSUPPORTED","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESERVED_METADATA_KEY","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TAX_CALCULATION_REQUIRED","TAX_INPUT_CONFLICT","TAX_MODE_MISMATCH","TIP_CURRENCY_MISMATCH","TIP_LIMIT_EXCEEDED","UNKNOWN_FIELD"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/orders/{order_id}/activities":{"get":{"description":"Returns a read-only, human-readable history log for an order. Use it to render timelines and debug what happened, not as a source of truth, ledger, or webhook replacement. Read the owning resource for authoritative state: the order for balances and status, the payment for payment state, the refund for refund outcomes, and the checkout session for checkout state. Do not sum balance_delta_money to compute an order balance. Informational rows such as payment_failed, refund_failed, and checkout_session_expired have a zero balance delta. The default order is newest first. Use sort_direction=asc for chronological timeline rendering. A typical chronological log might show created, payment_failed, payment, refund, then refund_failed; each row gives one reference to click through for the authoritative resource.","operationId":"listOrderActivities","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"Filter by activity type. Repeat the parameter or pass comma-separated values to OR multiple types.","explode":true,"in":"query","name":"type","required":false,"schema":{"items":{"enum":["created","line_item_added","line_item_updated","line_item_removed","discount_applied","discount_removed","tax_updated","requested_tip_added","requested_tip_updated","requested_tip_removed","charge_added","charge_updated","charge_removed","charge_fulfillment_updated","order_updated","adjustment","closed","payment","payment_failed","refund","refund_failed","checkout_session_created","checkout_session_expired","checkout_session_invalidated","fulfillment_created","fulfillment_updated","fulfillment_state_changed"],"type":"string","x-enum-descriptions":["Created.","Line item added.","Line item updated.","Line item removed.","Discount applied.","Discount removed.","Tax updated.","Requested tip added.","Requested tip updated.","Requested tip removed.","Charge added.","Charge updated.","Charge removed.","Charge fulfillment updated.","Order updated.","Adjustment.","Closed.","Payment.","Payment failed.","Refund.","Refund failed.","Checkout session created.","Checkout session expired.","Checkout session invalidated.","Fulfillment created.","Fulfillment updated.","Fulfillment state changed."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"activity_type":"payment","balance_delta_money":{"amount":-5000,"currency":"USD"},"created_at":"2026-03-17T14:35:00Z","description":"Payment received","order_activity_id":"act_123","payment_intent_id":"pi_123","running_balance_money":{"amount":0,"currency":"USD"}}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderActivityListResponse"}}},"description":"A page of order activities.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List order activities","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.read","commerce.orders.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/orders/{order_id}/charges":{"post":{"description":"Adds a service charge, fee, or surcharge to an order.","operationId":"addOrderCharge","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"charge":{"amount_money":{"amount":500,"currency":"USD"},"fulfillment_id":"ful_123","name":"Delivery","tax":{"taxable":true},"type":"delivery_fee"}},"schema":{"$ref":"#/components/schemas/AddOrderChargeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"The updated order.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Add order charge","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/orders/{order_id}/charges/{order_charge_id}":{"delete":{"description":"Removes a single service charge, fee, or surcharge from an order.","operationId":"deleteOrderCharge","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Flint order charge ID.","in":"path","name":"order_charge_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"The updated order.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order or charge not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Delete order charge","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"},"patch":{"description":"Updates a single service charge, fee, or surcharge on an order.","operationId":"updateOrderCharge","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Flint order charge ID.","in":"path","name":"order_charge_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"amount_money":{"amount":700,"currency":"USD"},"fulfillment_id":"ful_123","name":"Priority delivery"},"schema":{"$ref":"#/components/schemas/UpdateOrderChargeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"The updated order.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order or charge not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update order charge","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/orders/{order_id}/close":{"post":{"description":"Closes an eligible open, paid, or partially refunded order. Closing cancels pending discounts, releases pending promotion reservations, and recalculates totals from the current surviving pricing economics; canceled discounts remain visible with status: \"canceled\" but no longer reduce the total. Closing is blocked while payment collection is in progress.","operationId":"closeOrder","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"reason":"Customer canceled before payment."},"schema":{"$ref":"#/components/schemas/CloseOrderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"The closed order.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"examples":{"order_already_closed":{"summary":"Order already closed","value":{"error":{"code":"ORDER_ALREADY_CLOSED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Order is already closed.","remediation":{"next_steps":"Read the order and continue from its current terminal state instead of closing it again.","retryable":false},"request_id":"req_123","request_log_url":"/v1/developer/request-logs?request_id=req_123","type":"validation_error"}}},"order_refunded":{"summary":"Fully refunded order","value":{"error":{"code":"ORDER_REFUNDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Cannot close a fully refunded order.","remediation":{"next_steps":"Read the order and preserve its refunded terminal state.","retryable":false},"request_id":"req_123","request_log_url":"/v1/developer/request-logs?request_id=req_123","type":"validation_error"}}},"order_status_not_closable":{"summary":"Order status not closable","value":{"error":{"code":"ORDER_STATUS_NOT_CLOSABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The order status is not closable.","remediation":{"next_steps":"Read the order and complete the actions supported by its current status before retrying.","retryable":false},"request_id":"req_123","request_log_url":"/v1/developer/request-logs?request_id=req_123","type":"validation_error"}}},"payment_attempt_frozen":{"summary":"Payment attempt in flight","value":{"error":{"code":"PAYMENT_ATTEMPT_FROZEN","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Order cannot be closed while a linked payment attempt is in flight.","remediation":{"next_steps":"Wait for the payment attempt to finish, then read the order before retrying.","retryable":true},"request_id":"req_123","request_log_url":"/v1/developer/request-logs?request_id=req_123","type":"validation_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The order is not eligible to close, or a linked payment attempt blocks closing.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"examples":{"payment_attempt_in_progress":{"summary":"Payment attempt in progress","value":{"error":{"code":"PAYMENT_ATTEMPT_IN_PROGRESS","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"This order already has a payment attempt in progress. Wait for it to complete before closing the order.","remediation":{"next_steps":"Finish or cancel the owning payment attempt before changing the resource.","retryable":false},"request_id":"req_123","request_log_url":"/v1/developer/request-logs?request_id=req_123","type":"conflict_error"}}},"payment_attempt_still_processing":{"summary":"Payment attempt still processing","value":{"error":{"code":"PAYMENT_ATTEMPT_STILL_PROCESSING","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"A previous payment attempt is still being processed. Wait a moment, then refresh the order before trying again.","remediation":{"next_steps":"Wait briefly, then read the order and retry only after the attempt leaves processing.","retryable":true},"request_id":"req_123","request_log_url":"/v1/developer/request-logs?request_id=req_123","type":"conflict_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A payment attempt is in progress or still processing.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Close order","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","ORDER_ALREADY_CLOSED","ORDER_REFUNDED","ORDER_STATUS_NOT_CLOSABLE","PAYMENT_ATTEMPT_FROZEN","PAYMENT_ATTEMPT_IN_PROGRESS","PAYMENT_ATTEMPT_STILL_PROCESSING","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/orders/{order_id}/delivery-selections/current":{"get":{"description":"Returns the delivery selection committed to an order.","operationId":"getOrderCurrentDeliverySelection","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"amount_money":{"amount":0,"currency":"USD"},"calculation_expires_at":"2026-08-02T16:00:00Z","checkout_session_id":"cs_01K1P6G4M7H2N8Q9R3S5T6V7WX","choices":[{"amount_money":{"amount":0,"currency":"USD"},"delivery_choice_group_id":"dcgrp_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_method_id":"dmet_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_option_id":"dopt_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_plan":{"type":"single_delivery"},"discount_money":{"amount":0,"currency":"USD"},"name":"Standard delivery","stable_key":"example","tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":0,"currency":"USD"},"type":"shipment"}],"created_at":"2026-08-02T16:00:00Z","delivery_quote_id":"dqt_01K1P6G4M7H2N8Q9R3S5T6V7WX","delivery_quote_revision":0,"delivery_selection_id":"dsel_01K1P6G4M7H2N8Q9R3S5T6V7WX","eligibility_context_revision":0,"expires_at":"2026-08-02T16:00:00Z","lifecycle_updated_at":"2026-08-02T16:00:00Z","limiting_deadline_reason":"selection_guarantee_expiry","order_id":"ord_01K1P6G4M7H2N8Q9R3S5T6V7WX","status":"selected"},"request_id":"req_01K1P6G4M7H2N8Q9R3S5T6V7WX"},"schema":{"$ref":"#/components/schemas/DeliverySelectionResponse"}}},"description":"Committed order delivery selection.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery configuration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get current order delivery selection","tags":["orders","delivery_selections"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_ELIGIBILITY_CONTEXT_CHANGED","DELIVERY_EXPECTED_SELECTION_REQUIRED","DELIVERY_EXTERNAL_REFERENCE_REUSED","DELIVERY_OPTION_ALREADY_SELECTED","DELIVERY_OPTION_EXPIRED","DELIVERY_OPTION_NOT_IN_CHOICE_GROUP","DELIVERY_QUOTE_EXPIRED","DELIVERY_QUOTE_INPUT_CHANGED","DELIVERY_QUOTE_REVOKED","DELIVERY_SELECTION_CHANGED","DELIVERY_SELECTION_EXPIRED","DELIVERY_SELECTION_INCOMPLETE","DELIVERY_SELECTION_REPLACEMENT_LIMIT","DELIVERY_SELECTION_UNAVAILABLE","DELIVERY_SERVICE_UNAVAILABLE","DELIVERY_WINDOW_EXPIRED","DELIVERY_WINDOW_INVALID","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.read","commerce.orders.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/orders/{order_id}/discounts":{"post":{"description":"Applies a promotion-backed or manual discount to an order. Checkout-authenticated buyers must provide a promotion code; resource IDs and manual discounts require merchant authentication.","operationId":"applyOrderDiscount","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Checkout session ID when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"promotion":{"promotion_code":"SPRING15"}},"schema":{"$ref":"#/components/schemas/ApplyDiscountRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"The updated order.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order or promotion not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Apply discount","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","CHECKOUT_DISCOUNT_ID_NOT_ALLOWED","CHECKOUT_MANUAL_DISCOUNT_NOT_ALLOWED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/orders/{order_id}/discounts/preview":{"post":{"description":"Evaluates promotion outcomes for an order without mutating it. Merchant-authenticated callers may include a promotion by promotion_id or promotion_code; checkout-authenticated buyers must provide a code. The response includes applied, skipped, and single-threshold available promotion candidates.","operationId":"previewOrderDiscounts","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Checkout session ID when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"discount":{"promotion":{"promotion_code":"SPRING15"}}},"schema":{"$ref":"#/components/schemas/DiscountPreviewRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"example":{"data":{"discount_preview":{"applied":[{"amount_money":{"amount":1500,"currency":"USD"},"applied_money":{"amount":1500,"currency":"USD"},"customer_facing_name":"Summer sale","discount_class":"order","promotion_id":"promo_01HZYV7Q9Y0Y4H8Q3H9F6R7T8J","stacking_mode":"continue"}],"available":[{"current_money":{"amount":6700,"currency":"USD"},"customer_facing_name":"Free shipping over $75","discount_class":"service_charge","gap_money":{"amount":800,"currency":"USD"},"promotion_decline_reason":"minimum_not_met","promotion_id":"promo_01HZYV7Q9Y0Y4H8Q3H9F6R7T8M","threshold_money":{"amount":7500,"currency":"USD"}}],"skipped":[{"customer_facing_name":"Save 20%","discount_class":"order","promotion_decline_reason":"superseded_by_better_offer","promotion_id":"promo_01HZYV7Q9Y0Y4H8Q3H9F6R7T8K","would_have_applied_money":{"amount":1200,"currency":"USD"}}]}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/DiscountPreviewResponse"}}},"description":"The discount preview.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Preview discounts","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","CHECKOUT_DISCOUNT_ID_NOT_ALLOWED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.read","commerce.orders.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/orders/{order_id}/discounts/remove":{"post":{"description":"Removes one or more pending applied discounts from an order. Redeemed or canceled discounts are settlement history and cannot be removed.","operationId":"removeOrderDiscounts","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Checkout session ID when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"order_discount_ids":["01JFXH8Z2K7QF9V3MB0N4T6RCP"]},"schema":{"$ref":"#/components/schemas/RemoveDiscountsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"The updated order.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Remove discounts","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","CHECKOUT_DISCOUNT_NOT_REMOVABLE","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/orders/{order_id}/discounts/reprice":{"post":{"description":"Recalculates pending discounts and automatic promotions for a mutable order.","operationId":"repriceOrderDiscounts","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Checkout session ID when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"The repriced order.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Reprice discounts","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/orders/{order_id}/fulfillments":{"post":{"description":"Creates an explicit fulfillment for an order.","operationId":"createFulfillment","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"line_items":[{"order_line_item_id":"li_123","quantity":1}],"metadata":{"source":"dispatch"},"service_details":{"notes":"On-site setup"},"type":"service"},"schema":{"$ref":"#/components/schemas/CreateFulfillmentRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFulfillmentResponse"}}},"description":"The updated order.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order or fulfillment not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create fulfillment","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/orders/{order_id}/inventory-exception/resolve":{"post":{"description":"Marks a paid inventory failure as resolved after an operator has completed manual inventory remediation.","operationId":"resolveOrderInventoryException","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"reason":"Manual inventory sourced and deducted."},"schema":{"$ref":"#/components/schemas/ResolveOrderInventoryExceptionRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"The resolved order.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Resolve order inventory exception","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/orders/{order_id}/line-items":{"post":{"description":"Adds one or more line items to an order.","operationId":"addOrderLineItems","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"line_items":[{"name":"Backstage Upgrade","quantity":1,"unit_price_money":{"amount":1500,"currency":"USD"}}]},"schema":{"$ref":"#/components/schemas/AddLineItemsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"The updated order.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Add line items","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","AUTOMATIC_TAX_COMPONENTS_FORBIDDEN","AUTOMATIC_TAX_MULTIPLE_DESTINATIONS","AUTOMATIC_TAX_MULTIPLE_ORIGINS","AUTOMATIC_TAX_POST_TAX_DISCOUNT_UNSUPPORTED","BUNDLE_NOT_SELLABLE","CATALOG_INVENTORY_RELATIONSHIP_INVALID","CATALOG_LINE_ITEM_CURRENCY_CHANGED","CATALOG_LINE_ITEM_FIELDS_READ_ONLY","CATALOG_LINE_ITEM_SOURCE_CHANGED","CHECKOUT_TAX_CALCULATION_LIMIT_REACHED","CURRENCY_MISMATCH","DUPLICATE_TAX_COMPONENT","EXTERNAL_IMAGE_NOT_ALLOWED","EXTERNAL_TAX_COMPONENTS_REQUIRED","FIELD_REQUIRED","FLAT_TAX_SCOPE_INVALID","FULFILLMENT_BUNDLE_UNSUPPORTED","FULFILLMENT_CONFIGURATION_ACTION_REQUIRED","FULFILLMENT_PROFILE_REVISION_UNUSABLE","FULFILLMENT_REQUIREMENT_REQUIRED","IDEMPOTENCY_CLEAR_FAILED","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","IDEMPOTENCY_LOAD_FAILED","IDEMPOTENCY_PERSIST_FAILED","IDEMPOTENCY_RECORD_INVALID","IDEMPOTENCY_RECOVERY_REQUIRED","IMAGE_ASSET_NOT_ATTACHABLE","IMAGE_ASSET_NOT_FOUND","IMAGE_URL_INVALID","IMAGE_URL_MUST_BE_CANONICAL","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_CURRENCY","INVALID_FIELD_TYPE","INVALID_FULFILLMENT_REQUIREMENT","INVALID_ID","INVALID_IDEMPOTENCY_KEY","INVALID_IMAGE_ALT","INVALID_LINE_ITEMS","INVALID_METADATA_KEY","INVALID_REQUEST","INVALID_TAX_CALCULATION_TYPE","INVALID_TAX_CATEGORY","INVALID_TAX_JURISDICTION","INVALID_TAX_PERCENTAGE","INVALID_TAX_PRICE_MODE","INVALID_TAX_TYPE","INVALID_TOTALS","INVENTORY_DEMAND_DUPLICATE","INVENTORY_DEMAND_INVALID","INVENTORY_RESERVATION_EXISTS","INVENTORY_ROUTING_SOURCE_REQUIRED","INVOICE_LOCKED_ORDER_FINANCIALS","LINE_ITEM_INVALID_QUANTITY","LINE_ITEM_NAME_REQUIRED","LINE_ITEM_NAME_TOO_LONG","LINE_ITEM_NEGATIVE_PRICE","LINE_ITEM_PRICE_REQUIRED","LINE_ITEM_QUANTITY_TOO_LARGE","LINE_ITEM_SOURCE_CONFLICT","LINE_ITEM_UNIT_PRICE_REQUIRED","METADATA_KEY_TOO_LONG","METADATA_TOO_LARGE","METADATA_TOO_MANY_KEYS","METADATA_VALUE_TOO_LONG","MISSING_LINE_ITEMS","MODIFIER_CURRENCY_MISMATCH","MODIFIER_DUPLICATE_SELECTION","MODIFIER_GROUP_REQUIRED","MODIFIER_QUANTITY_INVALID","MODIFIER_SELECTION_LIMIT_EXCEEDED","MODIFIER_SOURCE_UNSUPPORTED","MODIFIER_TEXT_INVALID","MODIFIER_UNAVAILABLE","NULL_NOT_ALLOWED","ORDER_CLOSED","ORDER_COLLECTION_ALREADY_ACTIVE","ORDER_FINANCIAL_MUTATION_NOT_ALLOWED","ORDER_LINE_ITEM_TAX_INPUT_REQUIRED","ORDER_TAX_CALCULATION_FAILED","ORDER_TAX_RATE_UNAVAILABLE","ORDER_TAX_UNSUPPORTED_COUNTRY","ORDER_TOTAL_BELOW_NET_COLLECTED","PRODUCT_LINE_ITEM_SOURCE_UNSUPPORTED","PROMOTION_CONFLICT","PROMOTION_DECLINED","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESERVED_METADATA_KEY","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","TAX_CALCULATION_REQUIRED","TAX_MODE_MISMATCH","TOO_MANY_LINE_ITEMS","UNKNOWN_FIELD","UNSUPPORTED_CURRENCY","VARIANT_NOT_SELLABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/orders/{order_id}/line-items/{order_line_item_id}":{"delete":{"description":"Removes a single line item from an order.","operationId":"deleteOrderLineItem","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Flint order line item ID.","in":"path","name":"order_line_item_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"The updated order.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order or line item not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Delete line item","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_DESTINATION_NOT_APPLICABLE","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"},"patch":{"description":"Updates a single line item on an order.","operationId":"updateOrderLineItem","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Flint order line item ID.","in":"path","name":"order_line_item_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Checkout session ID for buyer-facing checkout authentication.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret for buyer-facing checkout authentication.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"expected_version":1,"modifiers":[{"text":{"modifier_group_id":"mg_123","value":"No onions"}}]},"schema":{"$ref":"#/components/schemas/UpdateLineItemRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"api_key":{"value":{"data":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"checkout_session":{"value":{"data":{"checkout_total_money":{"amount":5000,"currency":"USD"},"line_item":{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":2},"payment_amount_money":{"amount":5000,"currency":"USD"},"version":2},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/OrderResponse"},{"$ref":"#/components/schemas/CheckoutSessionLineItemModifierUpdateResponse"}]}}},"description":"The updated order, or the updated checkout line item modifier state.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order or line item not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update line item","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/orders/{order_id}/pay":{"post":{"description":"Starts or resumes a payment attempt on the order. Set action to pay to charge the full outstanding balance, confirm_payment_intents to confirm order-owned payment intents, setup to save a newly collected token on a zero-balance order, or resume to continue an attempt after a pending client action. Each action accepts only its own fields. Only confirm_payment_intents accepts completion_behavior. A pay action without payment_source is valid only when the outstanding balance is zero. To resume, send action: resume with payment_attempt_id, or replay the exact original request with the same Idempotency-Key while the attempt is open. Payment intents with manual capture return an active authorization instead of settling immediately.","operationId":"payOrder","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Checkout session ID when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"confirm_payment_intents":{"summary":"Confirm existing payment intents","value":{"action":"confirm_payment_intents","buyer_email":"buyer@example.com","expected_outstanding_money":{"amount":2500,"currency":"USD"},"payment_intents":[{"confirmation_token":"ctoken_123","payment_intent_id":"pi_123"}]}},"pay":{"summary":"Pay the full balance","value":{"action":"pay","expected_outstanding_money":{"amount":2500,"currency":"USD"},"payment_source":{"confirmation_token":"ctoken_123"}}},"resume":{"summary":"Resume an attempt","value":{"action":"resume","payment_attempt_id":"opat_01J9ZK1AQ5FYF6M7VQY11M2Z3A"}},"setup":{"summary":"Save a credential","value":{"action":"setup","expected_outstanding_money":{"amount":0,"currency":"USD"},"setup_payment_source":{"token":"src_123"}}}},"schema":{"$ref":"#/components/schemas/PayOrderRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"order":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"payment_attempt":{"expected_outstanding_money":{"amount":2500,"currency":"USD"},"is_resumable":true,"mode":"payment","payment_attempt_id":"opat_01ARZ3NDEKTSV4RRFFQ69G5FAV","payment_intents":[{"amount_money":{"amount":2500,"currency":"USD"},"payment_intent_id":"pi_123","status":"requires_action","tip_money":{"amount":0,"currency":"USD"}}],"pending_actions":[{"action_type":"payment_authentication","client_action":{"stripe":{"account_id":"acct_123","payment_intent":{"client_secret":"pi_client_secret_123","stripe_js_call":"handle_next_action"},"publishable_key":"pk_test_123"}},"pending_action_id":"pendact_01ARZ3NDEKTSV4RRFFQ69G5FAV","subject":{"payment_intent":{"payment_intent_id":"pi_123"}}}],"status":"requires_action"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PayOrderResponse"}}},"description":"The updated order and any pending payment actions.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Pay order","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","FIELD_REQUIRED","FULFILLMENT_SELECTION_REQUIRED","INSUFFICIENT_SCOPE","INVALID_ACTION","INVALID_API_KEY","INVALID_FIELD_TYPE","INVALID_REQUEST","NULL_NOT_ALLOWED","PAYMENT_SOURCE_CONFLICT","PAYMENT_SOURCE_NOT_ALLOWED","PAYMENT_SOURCE_REQUIRED","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","UNKNOWN_FIELD"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/orders/{order_id}/payment-attempts":{"get":{"description":"Returns payment attempts for the order, newest first. Checkout-session callers see only attempts created by their own session.","operationId":"listOrderPaymentAttempts","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Checkout session ID when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"expected_outstanding_money":{"amount":2500,"currency":"USD"},"is_resumable":true,"mode":"payment","payment_attempt_id":"opat_01ARZ3NDEKTSV4RRFFQ69G5FAV","payment_intents":[{"amount_money":{"amount":2500,"currency":"USD"},"payment_intent_id":"pi_123","status":"requires_action","tip_money":{"amount":0,"currency":"USD"}}],"pending_actions":[{"action_type":"payment_authentication","client_action":{"stripe":{"account_id":"acct_123","payment_intent":{"client_secret":"pi_client_secret_123","stripe_js_call":"handle_next_action"},"publishable_key":"pk_test_123"}},"pending_action_id":"pendact_01ARZ3NDEKTSV4RRFFQ69G5FAV","subject":{"payment_intent":{"payment_intent_id":"pi_123"}}}],"status":"requires_action"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderPaymentAttemptListResponse"}}},"description":"A page of payment attempts.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List order payment attempts","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.read","commerce.orders.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/orders/{order_id}/payment-attempts/{payment_attempt_id}":{"get":{"description":"Returns one durable payment attempt for the order. Checkout-session callers can read only attempts created by their own session.","operationId":"getOrderPaymentAttempt","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Flint order payment attempt ID.","in":"path","name":"payment_attempt_id","required":true,"schema":{"type":"string"}},{"description":"Checkout session ID when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"expected_outstanding_money":{"amount":2500,"currency":"USD"},"is_resumable":true,"mode":"payment","payment_attempt_id":"opat_01ARZ3NDEKTSV4RRFFQ69G5FAV","payment_intents":[{"amount_money":{"amount":2500,"currency":"USD"},"payment_intent_id":"pi_123","status":"requires_action","tip_money":{"amount":0,"currency":"USD"}}],"pending_actions":[{"action_type":"payment_authentication","client_action":{"stripe":{"account_id":"acct_123","payment_intent":{"client_secret":"pi_client_secret_123","stripe_js_call":"handle_next_action"},"publishable_key":"pk_test_123"}},"pending_action_id":"pendact_01ARZ3NDEKTSV4RRFFQ69G5FAV","subject":{"payment_intent":{"payment_intent_id":"pi_123"}}}],"status":"requires_action"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderPaymentAttemptResponse"}}},"description":"The requested payment attempt.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order or payment attempt not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get order payment attempt","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.read","commerce.orders.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/orders/{order_id}/payment-attempts/{payment_attempt_id}/cancel":{"post":{"description":"Cancels an active order payment attempt, its unsettled payment legs, and its attempt-owned holds.","operationId":"cancelOrderPaymentAttempt","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Flint order payment attempt ID.","in":"path","name":"payment_attempt_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Checkout session ID when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"cancellation_reason":"abandoned"},"schema":{"$ref":"#/components/schemas/CancelOrderPaymentAttemptRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"example":{"data":{"order":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"payment_attempt":{"expected_outstanding_money":{"amount":2500,"currency":"USD"},"is_resumable":true,"mode":"payment","payment_attempt_id":"opat_01ARZ3NDEKTSV4RRFFQ69G5FAV","payment_intents":[{"amount_money":{"amount":2500,"currency":"USD"},"payment_intent_id":"pi_123","status":"requires_action","tip_money":{"amount":0,"currency":"USD"}}],"pending_actions":[{"action_type":"payment_authentication","client_action":{"stripe":{"account_id":"acct_123","payment_intent":{"client_secret":"pi_client_secret_123","stripe_js_call":"handle_next_action"},"publishable_key":"pk_test_123"}},"pending_action_id":"pendact_01ARZ3NDEKTSV4RRFFQ69G5FAV","subject":{"payment_intent":{"payment_intent_id":"pi_123"}}}],"status":"requires_action"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CancelOrderPaymentAttemptResponse"}}},"description":"The updated order and canceled payment attempt.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order or payment attempt not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Cancel order payment attempt","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/orders/{order_id}/payment-intents":{"post":{"description":"Creates an immutable payment leg owned by the order. Collect a payment source using payment_collection, then submit that source through payOrder. This route requires commerce.orders.write; standalone payment-intent routes require payments.payment_intents.write.","operationId":"createOrderPaymentIntent","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Checkout session ID when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"amount_money":{"amount":10000,"currency":"USD"},"capture_method":"automatic","payment_source_selection":{"card":{"digital_wallets":["apple_pay","google_pay"]}}},"schema":{"$ref":"#/components/schemas/CreateOrderPaymentIntentRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"payment_collection":{"stripe":{"account_id":"acct_example","elements":{"amount_money":{"amount":10000,"currency":"USD"},"digital_wallets":["apple_pay","google_pay"],"mode":"payment","next_step":"collect_payment_source","payment_method_creation":"manual","payment_method_types":["card"],"submit_to":"pay_order"},"publishable_key":"pk_test_example"}},"payment_intent":{"amount_money":{"amount":10000,"currency":"USD"},"order_id":"ord_01ARZ3NDEKTSV4RRFFQ69G5FAV","payment_intent_id":"pi_01ARZ3NDEKTSV4RRFFQ69G5FAV","status":"requires_payment_method"}},"request_id":"req_01ARZ3NDEKTSV4RRFFQ69G5FAV"},"schema":{"$ref":"#/components/schemas/CreateOrderPaymentIntentResponse"}}},"description":"The order-owned payment intent and payment collection guidance.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create order payment intent","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/orders/{order_id}/payment-intents/{payment_intent_id}/cancel":{"post":{"description":"Cancels an unsettled order-owned payment leg. A leg in an active payment attempt requires the matching payment_attempt_id. Canceling an authorization releases the payment lock and attempt-owned holds; a staged or declined leg with no active attempt can be canceled without an attempt ID.","operationId":"cancelOrderPayment","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Flint payment intent ID.","in":"path","name":"payment_intent_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Checkout session ID when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"cancellation_reason":"requested_by_customer","payment_attempt_id":"opat_01J9ZK1AQ5FYF6M7VQY11M2Z3A"},"schema":{"$ref":"#/components/schemas/CancelOrderPaymentRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"example":{"data":{"order":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"payment_attempt":{"expected_outstanding_money":{"amount":2500,"currency":"USD"},"is_resumable":true,"mode":"payment","payment_attempt_id":"opat_01ARZ3NDEKTSV4RRFFQ69G5FAV","payment_intents":[{"amount_money":{"amount":2500,"currency":"USD"},"payment_intent_id":"pi_123","status":"requires_action","tip_money":{"amount":0,"currency":"USD"}}],"pending_actions":[{"action_type":"payment_authentication","client_action":{"stripe":{"account_id":"acct_123","payment_intent":{"client_secret":"pi_client_secret_123","stripe_js_call":"handle_next_action"},"publishable_key":"pk_test_123"}},"pending_action_id":"pendact_01ARZ3NDEKTSV4RRFFQ69G5FAV","subject":{"payment_intent":{"payment_intent_id":"pi_123"}}}],"status":"requires_action"},"payment_intent":{"amount_money":{"amount":2500,"currency":"USD"},"last_payment_error":null,"payment_flow":"","payment_intent_id":"pi_123","payment_options":null,"risk":null,"status":"succeeded","support_reference":""}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderPaymentLifecycleResponse"}}},"description":"The updated order, canceled payment intent, and owning payment attempt when one exists.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order or payment intent not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Cancel order payment leg","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/orders/{order_id}/payment-intents/{payment_intent_id}/capture":{"post":{"description":"Captures an active payment authorization for an order and updates the order payment lifecycle.","operationId":"captureOrderPayment","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Flint payment intent ID.","in":"path","name":"payment_intent_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"amount_money":{"amount":2500,"currency":"USD"},"payment_attempt_id":"opat_01J9ZK1AQ5FYF6M7VQY11M2Z3A"},"schema":{"$ref":"#/components/schemas/CaptureOrderPaymentRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"example":{"data":{"order":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","line_items":[{"base_subtotal_money":{"amount":5000,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"inventory_snapshot":null,"metadata":{"ticket_type":"ga"},"modifier_total_money":{"amount":0,"currency":"USD"},"name":"General Admission","order_line_item_id":"li_123","quantity":2,"refunded_money":{"amount":0,"currency":"USD"},"refunded_quantity":0,"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"},"unit_price_money":{"amount":2500,"currency":"USD"},"version":1}],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","tax":{"enabled":false,"mode":"automatic","status":"not_required","taxability_reason":"tax_disabled"},"updated_at":"2026-03-17T14:30:00Z"},"payment_attempt":{"expected_outstanding_money":{"amount":2500,"currency":"USD"},"is_resumable":true,"mode":"payment","payment_attempt_id":"opat_01ARZ3NDEKTSV4RRFFQ69G5FAV","payment_intents":[{"amount_money":{"amount":2500,"currency":"USD"},"payment_intent_id":"pi_123","status":"requires_action","tip_money":{"amount":0,"currency":"USD"}}],"pending_actions":[{"action_type":"payment_authentication","client_action":{"stripe":{"account_id":"acct_123","payment_intent":{"client_secret":"pi_client_secret_123","stripe_js_call":"handle_next_action"},"publishable_key":"pk_test_123"}},"pending_action_id":"pendact_01ARZ3NDEKTSV4RRFFQ69G5FAV","subject":{"payment_intent":{"payment_intent_id":"pi_123"}}}],"status":"requires_action"},"payment_intent":{"amount_money":{"amount":2500,"currency":"USD"},"last_payment_error":null,"payment_flow":"","payment_intent_id":"pi_123","payment_options":null,"risk":null,"status":"succeeded","support_reference":""}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrderPaymentLifecycleResponse"}}},"description":"The updated order, captured payment intent, and owning payment attempt.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order or payment intent not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Capture order payment","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/orders/{order_id}/receipt":{"post":{"description":"Queues another receipt email for a paid order when Flint manages receipt delivery. The recipient is derived from the order and cannot be supplied by the caller. When the merchant manages receipt delivery, ask the merchant for another copy.","operationId":"resendOrderReceipt","parameters":[{"description":"Flint order ID.","in":"path","name":"order_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Checkout session ID when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionResponse"}}},"description":"The receipt was queued.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Idempotency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Resend an order receipt","tags":["orders"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","ORDER_RECEIPT_EMAIL_UNAVAILABLE","ORDER_RECEIPT_MERCHANT_MANAGED","ORDER_RECEIPT_NOT_AVAILABLE","ORDER_RECEIPT_RESEND_RATE_LIMITED","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/organizations":{"get":{"description":"Returns the organizations accessible to the caller, filtered to the authenticated merchant's organization subtree for external API keys.","operationId":"listOrganizations","parameters":[{"description":"Optional parent organization filter.","in":"query","name":"parent_organization_id","required":false,"schema":{"type":"string"}},{"description":"Optional organization status filter.","in":"query","name":"status","required":false,"schema":{"enum":["active","deleted"],"type":"string","x-enum-descriptions":["Active.","Deleted."],"x-flint-enum":"open"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["name","created_at","updated_at"],"type":"string","x-enum-descriptions":["Name.","Created at.","Updated at."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"RFC3339 lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 lower bound for updated_at.","in":"query","name":"updated_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for updated_at.","in":"query","name":"updated_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"created_at":"2026-03-18T09:15:00Z","metadata":{"segment":"enterprise"},"name":"Northeast Region","organization_id":"org_01JQ4X6Q1G6NMBM4Q0E2W9X6YZ","parent_organization_id":"org_01JQ4X2R0W0RTM8VJQ8YQ7P9AB","status":"active","updated_at":"2026-03-18T09:15:00Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrganizationListResponse"}}},"description":"The requested organizations.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List organizations","tags":["organizations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["accounts.organizations.read","accounts.organizations.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates a child organization within the caller's accessible organization hierarchy.","operationId":"createOrganization","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"metadata":{"segment":"enterprise"},"name":"Northeast Region","parent_organization_id":"org_01JQ4X2R0W0RTM8VJQ8YQ7P9AB"},"schema":{"$ref":"#/components/schemas/CreateOrganizationRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-18T09:15:00Z","metadata":{"segment":"enterprise"},"name":"Northeast Region","organization_id":"org_01JQ4X6Q1G6NMBM4Q0E2W9X6YZ","parent_organization_id":"org_01JQ4X2R0W0RTM8VJQ8YQ7P9AB","status":"active","updated_at":"2026-03-18T09:15:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrganizationResponse"}}},"description":"The created organization.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"organization not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Parent organization not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create organization","tags":["organizations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["accounts.organizations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/organizations/{organization_id}":{"delete":{"description":"Soft-deletes an organization when it has no active descendants or merchant links.","operationId":"deleteOrganization","parameters":[{"description":"Flint organization ID.","in":"path","name":"organization_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-18T09:15:00Z","metadata":{"segment":"enterprise"},"name":"Northeast Region","organization_id":"org_01JQ4X6Q1G6NMBM4Q0E2W9X6YZ","parent_organization_id":"org_01JQ4X2R0W0RTM8VJQ8YQ7P9AB","status":"active","updated_at":"2026-03-18T09:15:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrganizationResponse"}}},"description":"The deleted organization.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"organization not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Organization not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Delete organization","tags":["organizations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["accounts.organizations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"},"get":{"description":"Returns an accessible organization by ID.","operationId":"getOrganization","parameters":[{"description":"Flint organization ID.","in":"path","name":"organization_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: parent_organization. Expansion requires accounts.organizations.read. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=parent_organization\u0026expand=parent_organization, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["parent_organization"],"type":"string","x-enum-descriptions":["Parent organization."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Organization","value":{"data":{"created_at":"2026-03-18T09:15:00Z","metadata":{"segment":"enterprise"},"name":"Northeast Region","organization_id":"org_01JQ4X6Q1G6NMBM4Q0E2W9X6YZ","parent_organization_id":"org_01JQ4X2R0W0RTM8VJQ8YQ7P9AB","status":"active","updated_at":"2026-03-18T09:15:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Organization with expanded parent organization","value":{"data":{"created_at":"2026-03-18T09:15:00Z","metadata":{"segment":"enterprise"},"name":"Northeast Region","organization_id":"org_01JQ4X6Q1G6NMBM4Q0E2W9X6YZ","parent_organization":{"created_at":"2026-03-17T09:15:00Z","name":"North America","organization_id":"org_01JQ4X2R0W0RTM8VJQ8YQ7P9AB","status":"active","updated_at":"2026-03-17T09:15:00Z"},"parent_organization_id":"org_01JQ4X2R0W0RTM8VJQ8YQ7P9AB","status":"active","updated_at":"2026-03-18T09:15:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/OrganizationResponse"}}},"description":"The requested organization.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"organization not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Organization not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get organization","tags":["organizations"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["accounts.organizations.read","accounts.organizations.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Applies a sparse update to an accessible organization.","operationId":"updateOrganization","parameters":[{"description":"Flint organization ID.","in":"path","name":"organization_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"metadata":{"segment":"retail"},"name":"Northeast Retail"},"schema":{"$ref":"#/components/schemas/UpdateOrganizationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-18T09:15:00Z","metadata":{"segment":"enterprise"},"name":"Northeast Region","organization_id":"org_01JQ4X6Q1G6NMBM4Q0E2W9X6YZ","parent_organization_id":"org_01JQ4X2R0W0RTM8VJQ8YQ7P9AB","status":"active","updated_at":"2026-03-18T09:15:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrganizationResponse"}}},"description":"The updated organization.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"organization not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Organization not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update organization","tags":["organizations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["accounts.organizations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/organizations/{organization_id}/memberships":{"get":{"description":"Returns the direct memberships for an organization.","operationId":"listOrganizationMemberships","parameters":[{"description":"Flint organization ID.","in":"path","name":"organization_id","required":true,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"created_at":"2026-03-18T10:00:00Z","organization_id":"org_01JQ4X6Q1G6NMBM4Q0E2W9X6YZ","role":"admin","status":"active","updated_at":"2026-03-18T10:00:00Z","user_id":"usr_01JQ4X9G7C2R9M18D1T9EAV1KX"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrganizationMembershipListResponse"}}},"description":"The organization memberships.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"organization not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Organization not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List organization memberships","tags":["organizations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["accounts.organizations.read","accounts.organizations.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Adds or updates a direct organization membership for a user.","operationId":"grantOrganizationMembership","parameters":[{"description":"Flint organization ID.","in":"path","name":"organization_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"role":"admin","user_id":"usr_01JQ4X9G7C2R9M18D1T9EAV1KX"},"schema":{"$ref":"#/components/schemas/GrantOrganizationMembershipRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-18T10:00:00Z","organization_id":"org_01JQ4X6Q1G6NMBM4Q0E2W9X6YZ","role":"admin","status":"active","updated_at":"2026-03-18T10:00:00Z","user_id":"usr_01JQ4X9G7C2R9M18D1T9EAV1KX"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrganizationMembershipResponse"}}},"description":"The updated membership.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"201":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-18T10:00:00Z","organization_id":"org_01JQ4X6Q1G6NMBM4Q0E2W9X6YZ","role":"admin","status":"active","updated_at":"2026-03-18T10:00:00Z","user_id":"usr_01JQ4X9G7C2R9M18D1T9EAV1KX"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/OrganizationMembershipResponse"}}},"description":"The created membership.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"organization not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Organization or user not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Grant organization membership","tags":["organizations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["accounts.organizations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/organizations/{organization_id}/memberships/{user_id}":{"delete":{"description":"Revokes a direct organization membership for a user.","operationId":"revokeOrganizationMembership","parameters":[{"description":"Flint organization ID.","in":"path","name":"organization_id","required":true,"schema":{"type":"string"}},{"description":"Flint user ID.","in":"path","name":"user_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"organization_id":"org_01JQ4X6Q1G6NMBM4Q0E2W9X6YZ","user_id":"usr_01JQ4X9G7C2R9M18D1T9EAV1KX"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/RevokeOrganizationMembershipResponse"}}},"description":"The revoked membership reference.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"organization not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Organization or user not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Revoke organization membership","tags":["organizations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["accounts.organizations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/organizations/{organization_id}/transfer-ownership":{"post":{"description":"Transfers the organization owner role to another user.","operationId":"transferOrganizationOwnership","parameters":[{"description":"Flint organization ID.","in":"path","name":"organization_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"new_owner_user_id":"usr_01JQ4XB5PSE2K16K5M89KFBXW7"},"schema":{"$ref":"#/components/schemas/TransferOrganizationOwnershipRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"membership":{"created_at":"2026-03-18T11:00:00Z","organization_id":"org_01JQ4X6Q1G6NMBM4Q0E2W9X6YZ","role":"owner","status":"active","updated_at":"2026-03-18T11:00:00Z","user_id":"usr_01JQ4XB5PSE2K16K5M89KFBXW7"},"previous_owner_user_id":"usr_01JQ4WYYQJW1V1CQ8QK2KM3KQW"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/TransferOrganizationOwnershipResponse"}}},"description":"The transferred ownership result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"organization not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Organization or user not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Transfer organization ownership","tags":["organizations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["accounts.organizations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/packages":{"get":{"description":"Lists package records, newest created first.","operationId":"listPackages","parameters":[{"description":"Optional shipment ID filter.","in":"query","name":"shipment_id","required":false,"schema":{"type":"string"}},{"description":"Optional fulfillment ID filter.","in":"query","name":"fulfillment_id","required":false,"schema":{"type":"string"}},{"description":"Optional order ID filter.","in":"query","name":"order_id","required":false,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by external system identifier.","in":"query","name":"external_system","required":false,"schema":{"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search across package ID, external reference ID, and tracking number.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"carrier":"ups","created_at":"2026-05-13T16:01:00Z","dimensions":{"height":4,"length":8,"unit":"in","width":6},"external_reference_id":"pkg_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","metadata":{"box":"small"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","service_code":"ground","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"created","supported_actions":["mark_packed","mark_shipped","mark_in_transit","mark_out_for_delivery","mark_delivered","mark_delivery_attempted","mark_exception"],"tracking_number":"1Z999AA10123456784","tracking_url":"https://track.example.com/1Z999AA10123456784","updated_at":"2026-05-13T16:01:00Z","version":1,"weight":{"unit":"lb","value":1.2}}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PackageListResponse"}}},"description":"Packages for the shipment.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List packages","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.read","commerce.orders.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/packages/{package_id}":{"get":{"description":"Retrieves one package by ID.","operationId":"getPackage","parameters":[{"description":"Flint package ID.","in":"path","name":"package_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: order. Expansion requires commerce.orders.read. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=order\u0026expand=order, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["order"],"type":"string","x-enum-descriptions":["Order."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Package","value":{"data":{"carrier":"ups","created_at":"2026-05-13T16:01:00Z","dimensions":{"height":4,"length":8,"unit":"in","width":6},"external_reference_id":"pkg_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","metadata":{"box":"small"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","service_code":"ground","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"created","supported_actions":["mark_packed","mark_shipped","mark_in_transit","mark_out_for_delivery","mark_delivered","mark_delivery_attempted","mark_exception"],"tracking_number":"1Z999AA10123456784","tracking_url":"https://track.example.com/1Z999AA10123456784","updated_at":"2026-05-13T16:01:00Z","version":1,"weight":{"unit":"lb","value":1.2}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Package with expanded order","value":{"data":{"carrier":"ups","created_at":"2026-05-13T16:01:00Z","dimensions":{"height":4,"length":8,"unit":"in","width":6},"external_reference_id":"pkg_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","metadata":{"box":"small"},"order":{"created_at":"2026-05-13T09:30:00Z","customer_id":"cus_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_status":"completed","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","order_number":"1001","payment_intent_ids":["pi_01ABCDEFGHIJKLMNOPQRSTUVWX"],"payment_status":"","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","updated_at":"2026-05-13T14:30:00Z"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","service_code":"ground","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"created","supported_actions":["mark_packed","mark_shipped","mark_in_transit","mark_out_for_delivery","mark_delivered","mark_delivery_attempted","mark_exception"],"tracking_number":"1Z999AA10123456784","tracking_url":"https://track.example.com/1Z999AA10123456784","updated_at":"2026-05-13T16:01:00Z","version":1,"weight":{"unit":"lb","value":1.2}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/PackageResponse"}}},"description":"The package.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order, fulfillment, shipment, or package not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get package","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.read","commerce.orders.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Updates non-lifecycle package fields such as carrier, tracking, label access, measurements, metadata, and caller-owned external references. Package status cannot be patched directly. expected_version is optional and rejects a stale resource version when supplied.","operationId":"updatePackage","parameters":[{"description":"Flint package ID.","in":"path","name":"package_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"buyer_notification_behavior":"request","expected_version":1,"metadata":{"box":"small","packed_by":"warehouse-a"},"tracking_number":"1Z999AA10987654321","tracking_url":"https://track.example.com/1Z999AA10987654321"},"schema":{"$ref":"#/components/schemas/UpdatePackageRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"fulfillment_event":{"buyer_notification_behavior":"request","custom_details":{"current_carrier":"ups","current_service_code":"ground","current_tracking_number":"1Z999AA10123456784","current_tracking_url":"https://track.example.com/1Z999AA10123456784","resource_type":"package"},"event_type":"tracking_updated","fulfillment_event_id":"fev_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","message":"Package tracking updated","occurred_at":"2026-05-13T16:01:00Z","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","received_at":"2026-05-13T16:01:00Z","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","subject_type":""},"fulfillment_notifications":[{"channel":"email","created_at":"2026-05-13T16:01:00Z","fulfillment_event_id":"fev_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_notification_id":"fnt_01ABCDEFGHIJKLMNOPQRSTUVWX","notification_type":"tracking_updated","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","recipient_email":"buyer@example.com","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"pending","trigger_type":"fulfillment_event_created","updated_at":"2026-05-13T16:01:00Z"}],"package":{"carrier":"ups","created_at":"2026-05-13T16:01:00Z","dimensions":{"height":4,"length":8,"unit":"in","width":6},"external_reference_id":"pkg_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","metadata":{"box":"small"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","service_code":"ground","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"created","supported_actions":["mark_packed","mark_shipped","mark_in_transit","mark_out_for_delivery","mark_delivered","mark_delivery_attempted","mark_exception"],"tracking_number":"1Z999AA10123456784","tracking_url":"https://track.example.com/1Z999AA10123456784","updated_at":"2026-05-13T16:01:00Z","version":1,"weight":{"unit":"lb","value":1.2}}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/UpdatePackageResponse"}}},"description":"The updated package.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order, fulfillment, shipment, or package not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"PACKAGE_CHANGED","details":[{"code":"PACKAGE_CHANGED","current_resource":{"carrier":"ups","created_at":"2026-05-13T16:01:00Z","dimensions":{"height":4,"length":8,"unit":"in","width":6},"external_reference_id":"pkg_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","metadata":{"box":"small"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","service_code":"ground","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"out_for_delivery","supported_actions":["mark_delivery_attempted","mark_delivered","mark_exception","mark_returned"],"tracking_number":"1Z999AA10123456784","tracking_url":"https://track.example.com/1Z999AA10123456784","updated_at":"2026-05-14T12:05:01Z","version":4,"weight":{"unit":"lb","value":1.2}},"current_status":"out_for_delivery","current_version":4,"message":"the package changed","param":"expected_version","remediation":{"next_steps":"Read the current package and retry with its version as expected_version.","retryable":true}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"expected_version does not match the current package version; read the package and retry","param":"expected_version","remediation":{"next_steps":"Read the current package and retry with its version as expected_version.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The package version changed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update package","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_EXPECTED_VERSION","INVALID_REQUEST","PACKAGE_CHANGED","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/packages/{package_id}/items":{"get":{"description":"Lists order line quantities contained in packages.","operationId":"listPackageItems","parameters":[{"description":"Flint package ID.","in":"path","name":"package_id","required":true,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"created_at":"2026-05-13T16:02:00Z","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","metadata":{"slot":"A"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","order_line_item_id":"li_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","package_item_id":"pki_01ABCDEFGHIJKLMNOPQRSTUVWX","quantity":1,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","updated_at":"2026-05-13T16:02:00Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PackageItemListResponse"}}},"description":"Package items for the package.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order, fulfillment, shipment, or package not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List package items","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.read","commerce.orders.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Adds an order line quantity to a package. Total active package item quantities cannot exceed the parent fulfillment line-item quantity.","operationId":"createPackageItem","parameters":[{"description":"Flint package ID.","in":"path","name":"package_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"metadata":{"slot":"A"},"order_line_item_id":"li_01ABCDEFGHIJKLMNOPQRSTUVWX","quantity":1},"schema":{"$ref":"#/components/schemas/CreatePackageItemRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"created_at":"2026-05-13T16:02:00Z","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","metadata":{"slot":"A"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","order_line_item_id":"li_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","package_item_id":"pki_01ABCDEFGHIJKLMNOPQRSTUVWX","quantity":1,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","updated_at":"2026-05-13T16:02:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PackageItemResponse"}}},"description":"The newly created package item.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order, fulfillment, shipment, or package not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create package item","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/packages/{package_id}/items/{package_item_id}":{"delete":{"description":"Removes an order line quantity from a package while the package is still mutable.","operationId":"deletePackageItem","parameters":[{"description":"Flint package ID.","in":"path","name":"package_id","required":true,"schema":{"type":"string"}},{"description":"Flint package item ID.","in":"path","name":"package_item_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-05-13T16:02:00Z","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","metadata":{"slot":"A"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","order_line_item_id":"li_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","package_item_id":"pki_01ABCDEFGHIJKLMNOPQRSTUVWX","quantity":1,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","updated_at":"2026-05-13T16:02:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PackageItemResponse"}}},"description":"The deleted package item.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order, fulfillment, shipment, package, or item not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Delete package item","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Retrieves one package item by ID.","operationId":"getPackageItem","parameters":[{"description":"Flint package ID.","in":"path","name":"package_id","required":true,"schema":{"type":"string"}},{"description":"Flint package item ID.","in":"path","name":"package_item_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: order. Expansion requires commerce.orders.read. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=order\u0026expand=order, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["order"],"type":"string","x-enum-descriptions":["Order."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Package item","value":{"data":{"created_at":"2026-05-13T16:02:00Z","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","metadata":{"slot":"A"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","order_line_item_id":"li_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","package_item_id":"pki_01ABCDEFGHIJKLMNOPQRSTUVWX","quantity":1,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","updated_at":"2026-05-13T16:02:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Package item with expanded order","value":{"data":{"created_at":"2026-05-13T16:02:00Z","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","metadata":{"slot":"A"},"order":{"created_at":"2026-05-13T09:30:00Z","customer_id":"cus_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_status":"completed","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","order_number":"1001","payment_intent_ids":["pi_01ABCDEFGHIJKLMNOPQRSTUVWX"],"payment_status":"","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","updated_at":"2026-05-13T14:30:00Z"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","order_line_item_id":"li_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","package_item_id":"pki_01ABCDEFGHIJKLMNOPQRSTUVWX","quantity":1,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","updated_at":"2026-05-13T16:02:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/PackageItemResponse"}}},"description":"The package item.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order, fulfillment, shipment, package, or item not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get package item","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.read","commerce.orders.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Updates a package item quantity or metadata while the package is still mutable.","operationId":"updatePackageItem","parameters":[{"description":"Flint package ID.","in":"path","name":"package_id","required":true,"schema":{"type":"string"}},{"description":"Flint package item ID.","in":"path","name":"package_item_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"metadata":{"slot":"B"},"quantity":1},"schema":{"$ref":"#/components/schemas/UpdatePackageItemRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-05-13T16:02:00Z","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","metadata":{"slot":"A"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","order_line_item_id":"li_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","package_item_id":"pki_01ABCDEFGHIJKLMNOPQRSTUVWX","quantity":1,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","updated_at":"2026-05-13T16:02:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PackageItemResponse"}}},"description":"The updated package item.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order, fulfillment, shipment, package, or item not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update package item","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/packages/{package_id}/transitions":{"post":{"description":"Performs one action from the package's supported_actions. expected_version is optional and rejects a stale resource version when supplied.","operationId":"transitionPackage","parameters":[{"description":"Flint package ID.","in":"path","name":"package_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"action":"mark_out_for_delivery","buyer_notification_behavior":"send","expected_version":3},"schema":{"$ref":"#/components/schemas/PackageTransitionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"package":{"carrier":"ups","created_at":"2026-05-13T16:01:00Z","dimensions":{"height":4,"length":8,"unit":"in","width":6},"external_reference_id":"pkg_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","metadata":{"box":"small"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","service_code":"ground","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"out_for_delivery","supported_actions":["mark_delivery_attempted","mark_delivered","mark_exception","mark_returned"],"tracking_number":"1Z999AA10123456784","tracking_url":"https://track.example.com/1Z999AA10123456784","updated_at":"2026-05-14T12:05:01Z","version":4,"weight":{"unit":"lb","value":1.2}},"package_status_update":{"buyer_notification_behavior":"request","created_at":"2026-05-14T12:05:01Z","current_status":"out_for_delivery","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","occurred_at":"2026-05-14T12:05:00Z","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","package_status_update_id":"psu_01ABCDEFGHIJKLMNOPQRSTUVWX","previous_status":"in_transit","reason":"Carrier scan reported out for delivery.","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PackageStatusUpdateResponse"}}},"description":"The package transition result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Package not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"PACKAGE_CHANGED","details":[{"code":"PACKAGE_CHANGED","current_resource":{"carrier":"ups","created_at":"2026-05-13T16:01:00Z","dimensions":{"height":4,"length":8,"unit":"in","width":6},"external_reference_id":"pkg_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","metadata":{"box":"small"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","service_code":"ground","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"out_for_delivery","supported_actions":["mark_delivery_attempted","mark_delivered","mark_exception","mark_returned"],"tracking_number":"1Z999AA10123456784","tracking_url":"https://track.example.com/1Z999AA10123456784","updated_at":"2026-05-14T12:05:01Z","version":4,"weight":{"unit":"lb","value":1.2}},"current_status":"out_for_delivery","current_version":4,"message":"the package changed","param":"expected_version","remediation":{"next_steps":"Read the current package and retry with its version as expected_version.","retryable":true}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"expected_version does not match the current package version; read the package and retry","param":"expected_version","remediation":{"next_steps":"Read the current package and retry with its version as expected_version.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The action is not supported, the package version changed, or the package's shipment or fulfillment changed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Transition package","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","FIELD_REQUIRED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_STATUS_REASON_TOO_LONG","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INVALID_ACTION","INVALID_API_KEY","INVALID_EXPECTED_VERSION","INVALID_FIELD_TYPE","INVALID_FULFILLMENT_BUYER_NOTIFICATION_BEHAVIOR","INVALID_REQUEST","INVALID_TIMESTAMP","NULL_NOT_ALLOWED","PACKAGE_ACTION_NOT_ALLOWED","PACKAGE_CHANGED","PACKAGE_PARENT_CHANGED","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","UNKNOWN_FIELD"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/packages/{package_id}/void":{"post":{"description":"Voids a package before carrier handoff and appends a package timeline event. Voided package items no longer count against fulfillment package allocation capacity. expected_version is optional and rejects a stale resource version when supplied.","operationId":"voidPackage","parameters":[{"description":"Flint package ID.","in":"path","name":"package_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"buyer_notification_behavior":"suppress","expected_version":1,"occurred_at":"2026-05-13T16:09:00Z","reason":"Package was repacked before pickup."},"schema":{"$ref":"#/components/schemas/VoidPackageRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"example":{"data":{"event":{"buyer_notification_behavior":"","created_at":"2026-05-13T16:09:01Z","current_status":"voided","event_type":"status_changed","fulfillment_event_id":"fev_01ZYXWVUTSRQPONMLKJIHGFEC","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","occurred_at":"2026-05-13T16:09:00Z","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","previous_status":"created","reason":"Package was repacked before pickup.","received_at":"2026-05-13T16:09:01Z","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","subject_type":"package"},"package":{"carrier":"ups","created_at":"2026-05-13T16:01:00Z","dimensions":{"height":4,"length":8,"unit":"in","width":6},"external_reference_id":"pkg_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","metadata":{"box":"small"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","service_code":"ground","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"voided","supported_actions":["mark_packed","mark_shipped","mark_in_transit","mark_out_for_delivery","mark_delivered","mark_delivery_attempted","mark_exception"],"tracking_number":"1Z999AA10123456784","tracking_url":"https://track.example.com/1Z999AA10123456784","updated_at":"2026-05-13T16:08:01Z","version":1,"weight":{"unit":"lb","value":1.2}}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/VoidPackageResponse"}}},"description":"The voided package and timeline event.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order, fulfillment, shipment, or package not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"PACKAGE_CHANGED","details":[{"code":"PACKAGE_CHANGED","current_resource":{"carrier":"ups","created_at":"2026-05-13T16:01:00Z","dimensions":{"height":4,"length":8,"unit":"in","width":6},"external_reference_id":"pkg_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","metadata":{"box":"small"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","service_code":"ground","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"out_for_delivery","supported_actions":["mark_delivery_attempted","mark_delivered","mark_exception","mark_returned"],"tracking_number":"1Z999AA10123456784","tracking_url":"https://track.example.com/1Z999AA10123456784","updated_at":"2026-05-14T12:05:01Z","version":4,"weight":{"unit":"lb","value":1.2}},"current_status":"out_for_delivery","current_version":4,"message":"the package changed","param":"expected_version","remediation":{"next_steps":"Read the current package and retry with its version as expected_version.","retryable":true}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"expected_version does not match the current package version; read the package and retry","param":"expected_version","remediation":{"next_steps":"Read the current package and retry with its version as expected_version.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The package version changed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Void package","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_EXPECTED_VERSION","INVALID_REQUEST","PACKAGE_CHANGED","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/payment-intents":{"get":{"description":"Returns a paginated list of payment intents for the authenticated merchant.","operationId":"listPaymentIntents","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by order ID.","in":"query","name":"order_id","required":false,"schema":{"type":"string"}},{"description":"Filter by customer ID.","in":"query","name":"customer_id","required":false,"schema":{"type":"string"}},{"description":"Filter by invoice ID.","in":"query","name":"invoice_id","required":false,"schema":{"type":"string"}},{"description":"Filter by payment intent status.","in":"query","name":"status","required":false,"schema":{"enum":["requires_payment_method","requires_confirmation","requires_action","processing","requires_capture","canceled","succeeded","expired"],"type":"string","x-enum-descriptions":["Requires payment method.","Requires confirmation.","Requires action.","Processing.","Requires capture.","Canceled.","Succeeded.","Expired."],"x-flint-enum":"open"}},{"description":"Filter by payment origin.","in":"query","name":"origin","required":false,"schema":{"enum":["virtual_terminal","payment_link","checkout","api","subscription"],"type":"string","x-enum-descriptions":["Virtual terminal.","Payment link.","Checkout.","Api.","Subscription."],"x-flint-enum":"closed"}},{"description":"Filter by the latest completed risk assessment. Repeat or comma-separate values.","explode":true,"in":"query","name":"risk_level","required":false,"schema":{"items":{"enum":["normal","elevated","highest","not_assessed"],"type":"string","x-enum-descriptions":["Normal.","Elevated.","Highest.","Not assessed."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Filter by immutable payment flow. Repeat or comma-separate values.","explode":true,"in":"query","name":"payment_flow","required":false,"schema":{"items":{"enum":["checkout","payment_link","invoice","subscription_initial","subscription_renewal","virtual_terminal","api"],"type":"string","x-enum-descriptions":["Checkout.","Payment link.","Invoice.","Subscription initial.","Subscription renewal.","Virtual terminal.","Api."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Filter by linked Return ID.","in":"query","name":"return_id","required":false,"schema":{"type":"string"}},{"description":"Filter by linked ReturnResolution ID.","in":"query","name":"return_resolution_id","required":false,"schema":{"type":"string"}},{"description":"Search across payment_intent_id, external_reference_id, and receipt_email.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Inclusive lower bound in minor units. Requires currency.","in":"query","name":"min_amount","required":false,"schema":{"example":500,"format":"int64","minimum":1,"type":"integer"}},{"description":"Inclusive upper bound in minor units. Requires currency.","in":"query","name":"max_amount","required":false,"schema":{"example":500,"format":"int64","minimum":1,"type":"integer"}},{"description":"ISO 4217 currency for min_amount and max_amount.","in":"query","name":"currency","required":false,"schema":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"}},{"description":"Filter by aggregate payment-intent state preset.","in":"query","name":"state","required":false,"schema":{"enum":["with_refunds","fully_refunded","disputed","needs_action"],"type":"string","x-enum-descriptions":["With refunds.","Fully refunded.","Disputed.","Needs action."],"x-flint-enum":"closed"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["created_at","updated_at","amount"],"type":"string","x-enum-descriptions":["Created at.","Updated at.","Amount."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"RFC3339 lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 lower bound for updated_at.","in":"query","name":"updated_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for updated_at.","in":"query","name":"updated_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"amount_money":{"amount":5000,"currency":"USD"},"capture_method":"automatic","created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","external_reference_id":"cart_123","last_payment_error":null,"merchant_id":"mer_123","metadata":{"channel":"web"},"origin":"api","payment_flow":"","payment_intent_id":"pi_123","payment_options":["card","apple_pay"],"receipt_email":"buyer@example.com","refund_status":"none","risk":null,"settlement_status":"none","status":"requires_confirmation","support_reference":"","updated_at":"2026-03-17T14:30:00Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PaymentIntentListResponse"}}},"description":"A page of payment intents.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List payment intents","tags":["payment_intents"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["payments.payment_intents.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["payments.payment_intents.read","payments.payment_intents.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates a standalone payment intent for the authenticated merchant. Create order-owned payment intents with POST /v1/orders/{order_id}/payment-intents.","operationId":"createPaymentIntent","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"amount_money":{"amount":5000,"currency":"USD"},"capture_method":"automatic","customer_id":"cus_123","external_reference_id":"cart_123","metadata":{"channel":"web"},"payment_options":["card","apple_pay"],"receipt_email":"buyer@example.com"},"schema":{"$ref":"#/components/schemas/CreatePaymentIntentRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"examples":{"created":{"summary":"Created payment intent","value":{"data":{"payment_collection":{"stripe":{"account_id":"acct_123","elements":{"amount_money":{"amount":5000,"currency":"USD"},"digital_wallets":["apple_pay"],"mode":"payment","next_step":"create_confirmation_token","payment_method_creation":"manual","payment_method_types":["card"],"submit_to":"confirm_payment_intent"},"publishable_key":"pk_test_123"}},"payment_intent":{"amount_money":{"amount":5000,"currency":"USD"},"capture_method":"automatic","created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","external_reference_id":"cart_123","last_payment_error":null,"merchant_id":"mer_123","metadata":{"channel":"web"},"origin":"api","payment_flow":"","payment_intent_id":"pi_123","payment_options":["card","apple_pay"],"receipt_email":"buyer@example.com","refund_status":"none","risk":null,"settlement_status":"none","status":"requires_confirmation","support_reference":"","updated_at":"2026-03-17T14:30:00Z"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"created_with_readiness_warning":{"summary":"Created with merchant readiness warning","value":{"data":{"payment_collection":{"stripe":{"account_id":"acct_123","elements":{"amount_money":{"amount":5000,"currency":"USD"},"digital_wallets":["apple_pay"],"mode":"payment","next_step":"create_confirmation_token","payment_method_creation":"manual","payment_method_types":["card"],"submit_to":"confirm_payment_intent"},"publishable_key":"pk_test_123"}},"payment_intent":{"amount_money":{"amount":5000,"currency":"USD"},"capture_method":"automatic","created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","external_reference_id":"cart_123","last_payment_error":null,"merchant_id":"mer_123","metadata":{"channel":"web"},"origin":"api","payment_flow":"","payment_intent_id":"pi_123","payment_options":["card","apple_pay"],"receipt_email":"buyer@example.com","refund_status":"none","risk":null,"settlement_status":"none","status":"requires_confirmation","support_reference":"","updated_at":"2026-03-17T14:30:00Z"}},"meta":{"api_version":"2026-02-01","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","warnings":[{"code":"MERCHANT_ONBOARDING_DEADLINE_WARNING","message":"This merchant must complete onboarding requirements before the deadline to avoid payment processing interruption.","next_actions":[{"action_type":"review_merchant_readiness","reason_code":"MERCHANT_ONBOARDING_DEADLINE_WARNING","reason_message":"Review merchant readiness for the required remediation step.","required_scope":"merchants.profile.read","url":"/v1/merchants/mer_123"}],"observed_at":"2026-03-17T14:30:00Z","resource":"merchant","resource_id":"mer_123","severity":"warning"}]},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/CreatePaymentIntentResponse"}}},"description":"The created payment intent and any client-side confirmation details.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"MERCHANT_ONBOARDING_REQUIRED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Complete merchant onboarding before creating card payments.","param":"merchant_id","remediation":{"next_actions":[{"action_type":"review_merchant_readiness","reason_code":"MERCHANT_ONBOARDING_REQUIRED","reason_message":"Review merchant readiness for the required remediation step.","required_scope":"merchants.profile.read","url":"/v1/merchants/mer_123"}],"next_steps":"Complete the required merchant readiness or onboarding action before retrying.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Merchant readiness conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create standalone payment intent","tags":["payment_intents"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","MERCHANT_ONBOARDING_REQUIRED","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["payments.payment_intents.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["payments.payment_intents.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/payment-intents/{payment_intent_id}":{"get":{"description":"Returns a single payment intent by ID.","operationId":"getPaymentIntent","parameters":[{"description":"Flint payment intent ID.","in":"path","name":"payment_intent_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: customer, invoice, order. Expansion requires payments.payment_intents.read plus the read scope for each expanded resource. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=customer\u0026expand=invoice, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["customer","invoice","order"],"type":"string","x-enum-descriptions":["Customer.","Invoice.","Order."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Checkout session ID when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Standalone intent awaiting confirmation","value":{"data":{"amount_money":{"amount":5000,"currency":"USD"},"capture_method":"automatic","created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","external_reference_id":"cart_123","last_payment_error":null,"merchant_id":"mer_123","metadata":{"channel":"web"},"origin":"api","payment_collection":{"stripe":{"account_id":"acct_123","elements":{"amount_money":{"amount":5000,"currency":"USD"},"digital_wallets":["apple_pay"],"mode":"payment","next_step":"create_confirmation_token","payment_method_creation":"manual","payment_method_types":["card"],"submit_to":"confirm_payment_intent"},"publishable_key":"pk_test_123"}},"payment_flow":"","payment_intent_id":"pi_123","payment_options":["card","apple_pay"],"receipt_email":"buyer@example.com","refund_status":"none","risk":null,"settlement_status":"none","status":"requires_confirmation","support_reference":"","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Payment intent with expanded relationships","value":{"data":{"amount_money":{"amount":5000,"currency":"USD"},"capture_method":"automatic","created_at":"2026-03-17T14:30:00Z","customer":{"created_at":"2026-03-16T12:00:00Z","customer_id":"cus_123","email":"buyer@example.com","name":"Avery Buyer","updated_at":"2026-03-17T14:00:00Z"},"customer_id":"cus_123","external_reference_id":"cart_123","invoice":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","due_at":"2026-04-16T14:30:00Z","invoice_id":"inv_123","invoice_number":"1001","is_overdue":false,"order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"status":"open","updated_at":"2026-03-17T14:30:00Z"},"invoice_id":"inv_123","last_payment_error":null,"merchant_id":"mer_123","metadata":{"channel":"web"},"order":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","fulfillment_status":"not_fulfilled","order_id":"ord_123","order_number":"1001","payment_intent_ids":["pi_123"],"payment_status":"","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","updated_at":"2026-03-17T14:30:00Z"},"order_id":"ord_123","origin":"api","payment_flow":"","payment_intent_id":"pi_123","payment_options":["card","apple_pay"],"receipt_email":"buyer@example.com","refund_status":"none","risk":null,"settlement_status":"none","status":"requires_confirmation","support_reference":"","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/GetPaymentIntentResponse"}}},"description":"The requested payment intent. Standalone intents that still await initial confirmation may include payment_collection guidance. Intents that require a browser action may include typed current_payment_action authority.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"examples":{"invalid_expand":{"summary":"Unsupported expand path","value":{"error":{"code":"INVALID_EXPAND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Unknown expand path \"card\" for GET /v1/payment-intents/{payment_intent_id}. Supported values: customer, invoice, order.","param":"expand","remediation":{"next_steps":"Fix or remove the requested expand path; use only supported values documented for the route.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}},"validation":{"summary":"Validation error","value":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"payment intent not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment intent not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get payment intent","tags":["payment_intents"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_EXPAND","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["payments.payment_intents.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["payments.payment_intents.read","payments.payment_intents.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Applies a sparse update to a payment intent before it reaches a terminal state.","operationId":"updatePaymentIntent","parameters":[{"description":"Flint payment intent ID.","in":"path","name":"payment_intent_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"metadata":{"channel":"support"},"receipt_email":"updated@example.com"},"schema":{"$ref":"#/components/schemas/UpdatePaymentIntentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"amount_money":{"amount":5000,"currency":"USD"},"capture_method":"automatic","created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","external_reference_id":"cart_123","last_payment_error":null,"merchant_id":"mer_123","metadata":{"channel":"web"},"origin":"api","payment_flow":"","payment_intent_id":"pi_123","payment_options":["card","apple_pay"],"receipt_email":"buyer@example.com","refund_status":"none","risk":null,"settlement_status":"none","status":"requires_confirmation","support_reference":"","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PaymentIntentResponse"}}},"description":"The updated payment intent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"payment intent not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment intent not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update payment intent","tags":["payment_intents"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["payments.payment_intents.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["payments.payment_intents.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/payment-intents/{payment_intent_id}/cancel":{"post":{"description":"Cancels a standalone payment intent before it reaches a terminal settled state. Order-owned payment intents use the attempt-aware order cancellation route.","operationId":"cancelPaymentIntent","parameters":[{"description":"Flint payment intent ID.","in":"path","name":"payment_intent_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"cancellation_reason":"requested_by_customer"},"schema":{"$ref":"#/components/schemas/CancelPaymentIntentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"amount_money":{"amount":5000,"currency":"USD"},"capture_method":"automatic","created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","external_reference_id":"cart_123","last_payment_error":null,"merchant_id":"mer_123","metadata":{"channel":"web"},"origin":"api","payment_flow":"","payment_intent_id":"pi_123","payment_options":["card","apple_pay"],"receipt_email":"buyer@example.com","refund_status":"none","risk":null,"settlement_status":"none","status":"requires_confirmation","support_reference":"","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PaymentIntentResponse"}}},"description":"The canceled payment intent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"payment intent not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment intent not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Cancel payment intent","tags":["payment_intents"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["payments.payment_intents.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["payments.payment_intents.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/payment-intents/{payment_intent_id}/capture":{"post":{"description":"Captures an authorized standalone payment intent, including partial captures when supported. Order-owned payment intents use the attempt-aware order capture route.","operationId":"capturePaymentIntent","parameters":[{"description":"Flint payment intent ID.","in":"path","name":"payment_intent_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"amount_money":{"amount":3000,"currency":"USD"}},"schema":{"$ref":"#/components/schemas/CapturePaymentIntentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"amount_money":{"amount":5000,"currency":"USD"},"capture_method":"automatic","created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","external_reference_id":"cart_123","last_payment_error":null,"merchant_id":"mer_123","metadata":{"channel":"web"},"origin":"api","payment_flow":"","payment_intent_id":"pi_123","payment_options":["card","apple_pay"],"receipt_email":"buyer@example.com","refund_status":"none","risk":null,"settlement_status":"none","status":"requires_confirmation","support_reference":"","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PaymentIntentResponse"}}},"description":"The captured payment intent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"payment intent not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment intent not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Capture payment intent","tags":["payment_intents"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["payments.payment_intents.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["payments.payment_intents.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/payment-intents/{payment_intent_id}/confirm":{"post":{"description":"Confirms a standalone payment intent. Order-owned payment intents reject this route and must be confirmed through POST /v1/orders/{order_id}/pay.","operationId":"confirmPaymentIntent","parameters":[{"description":"Flint payment intent ID.","in":"path","name":"payment_intent_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"Checkout session ID when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"confirmation_token":"ctoken_123"},"schema":{"$ref":"#/components/schemas/ConfirmPaymentIntentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"amount_money":{"amount":5000,"currency":"USD"},"capture_method":"automatic","created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","external_reference_id":"cart_123","last_payment_error":null,"merchant_id":"mer_123","metadata":{"channel":"web"},"origin":"api","payment_flow":"","payment_intent_id":"pi_123","payment_options":["card","apple_pay"],"receipt_email":"buyer@example.com","refund_status":"none","risk":null,"settlement_status":"none","status":"requires_confirmation","support_reference":"","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PaymentIntentResponse"}}},"description":"The confirmed payment intent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"payment intent not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment intent not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Confirm payment intent","tags":["payment_intents"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["payments.payment_intents.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["payments.payment_intents.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"payment"}},"/v1/payment-links":{"get":{"description":"Returns a paginated list of payment links for the authenticated merchant.","operationId":"listPaymentLinks","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by payment link status.","in":"query","name":"status","required":false,"schema":{"enum":["active","inactive"],"type":"string","x-enum-descriptions":["Active.","Inactive."],"x-flint-enum":"open"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search across payment link ID, external reference ID, name, and description.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Filter by payment link type.","in":"query","name":"payment_link_type","required":false,"schema":{"enum":["standard","donation","event"],"type":"string","x-enum-descriptions":["Standard.","Donation.","Event."],"x-flint-enum":"closed"}},{"description":"Filter by whether the payment link references a subscription plan.","in":"query","name":"has_plan","required":false,"schema":{"type":"boolean"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["created_at","updated_at"],"type":"string","x-enum-descriptions":["Created at.","Updated at."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"RFC3339 lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"completed_count":3,"created_at":"2026-03-17T14:30:00Z","custom_fields":[{"custom_field_type":"dropdown","key":"meal_preference","label":"Meal preference","options":["Vegetarian","Chicken","Fish"],"payment_link_custom_field_id":"plcf_123","required":true}],"description":"Event checkout","event_config":{"event_at":"2026-05-12T19:00:00Z","max_total_quantity":500,"send_ticket_emails":true,"ticket_prefix":"GAL","venue":"Pier 57, New York"},"image":{"alt":"Spring gala","height":900,"url":"https://images.withflintpay.com/ia_spring_gala/original","width":1600},"line_items":[{"is_catalog_item_unavailable":false,"key":"general-admission","name":"General Admission","payment_link_line_item_id":"plli_123","quantity":1,"unit_price_money":{"amount":2500,"currency":"USD"}}],"merchant_id":"mer_123","metadata":{"campaign":"spring-gala"},"name":"Spring Gala","payment_link_id":"pl_123","payment_link_type":"event","payments":{"enabled_payment_options":["card","apple_pay","google_pay"]},"status":"active","total_quantity_sold":42,"updated_at":"2026-03-17T14:30:00Z","url":"https://checkout.withflintpay.com/pay/pl_123","version":1}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PaymentLinkListResponse"}}},"description":"A page of payment links.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List payment links","tags":["payment_links"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["checkouts.payment_links.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["checkouts.payment_links.read","checkouts.payment_links.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates a payment link for the authenticated merchant. Line items may use fixed prices, buyer-adjustable amounts, and buyer-adjustable quantities.","operationId":"createPaymentLink","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"custom_fields":[{"custom_field_type":"dropdown","key":"meal_preference","label":"Meal preference","options":["Vegetarian","Chicken","Fish"],"required":true}],"event_config":{"event_at":"2026-05-12T19:00:00Z","max_total_quantity":500,"send_ticket_emails":true,"ticket_prefix":"GAL","venue":"Pier 57, New York"},"line_items":[{"name":"General Admission","quantity":1,"unit_price_money":{"amount":2500,"currency":"USD"}},{"allow_unit_price_adjustment":true,"key":"donation","max_unit_price_money":{"amount":10000,"currency":"USD"},"min_unit_price_money":{"amount":100,"currency":"USD"},"name":"Optional Donation","quantity":1,"suggested_unit_price_money_options":[{"amount":500,"currency":"USD"},{"amount":1000,"currency":"USD"},{"amount":2500,"currency":"USD"}]}],"metadata":{"campaign":"spring-gala"},"name":"Spring Gala","payment_link_type":"event","payments":{"enabled_payment_options":["card","apple_pay","google_pay"]}},"schema":{"$ref":"#/components/schemas/CreatePaymentLinkRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"completed_count":3,"created_at":"2026-03-17T14:30:00Z","custom_fields":[{"custom_field_type":"dropdown","key":"meal_preference","label":"Meal preference","options":["Vegetarian","Chicken","Fish"],"payment_link_custom_field_id":"plcf_123","required":true}],"description":"Event checkout","event_config":{"event_at":"2026-05-12T19:00:00Z","max_total_quantity":500,"send_ticket_emails":true,"ticket_prefix":"GAL","venue":"Pier 57, New York"},"image":{"alt":"Spring gala","height":900,"url":"https://images.withflintpay.com/ia_spring_gala/original","width":1600},"line_items":[{"is_catalog_item_unavailable":false,"key":"general-admission","name":"General Admission","payment_link_line_item_id":"plli_123","quantity":1,"unit_price_money":{"amount":2500,"currency":"USD"}}],"merchant_id":"mer_123","metadata":{"campaign":"spring-gala"},"name":"Spring Gala","payment_link_id":"pl_123","payment_link_type":"event","payments":{"enabled_payment_options":["card","apple_pay","google_pay"]},"status":"active","total_quantity_sold":42,"updated_at":"2026-03-17T14:30:00Z","url":"https://checkout.withflintpay.com/pay/pl_123","version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PaymentLinkResponse"}}},"description":"The created payment link.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create payment link","tags":["payment_links"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_METHODS_NOT_APPLICABLE","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["checkouts.payment_links.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["checkouts.payment_links.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/payment-links/{payment_link_id}":{"get":{"description":"Returns a single payment link by ID.","operationId":"getPaymentLink","parameters":[{"description":"Flint payment link ID.","in":"path","name":"payment_link_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: subscription_plan. Expansion requires checkouts.payment_links.read plus commerce.subscription_plans.read. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=subscription_plan\u0026expand=subscription_plan, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["subscription_plan"],"type":"string","x-enum-descriptions":["Subscription plan."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Payment link","value":{"data":{"completed_count":3,"created_at":"2026-03-17T14:30:00Z","custom_fields":[{"custom_field_type":"dropdown","key":"meal_preference","label":"Meal preference","options":["Vegetarian","Chicken","Fish"],"payment_link_custom_field_id":"plcf_123","required":true}],"description":"Event checkout","event_config":{"event_at":"2026-05-12T19:00:00Z","max_total_quantity":500,"send_ticket_emails":true,"ticket_prefix":"GAL","venue":"Pier 57, New York"},"image":{"alt":"Spring gala","height":900,"url":"https://images.withflintpay.com/ia_spring_gala/original","width":1600},"line_items":[{"is_catalog_item_unavailable":false,"key":"general-admission","name":"General Admission","payment_link_line_item_id":"plli_123","quantity":1,"unit_price_money":{"amount":2500,"currency":"USD"}}],"merchant_id":"mer_123","metadata":{"campaign":"spring-gala"},"name":"Spring Gala","payment_link_id":"pl_123","payment_link_type":"event","payments":{"enabled_payment_options":["card","apple_pay","google_pay"]},"status":"active","total_quantity_sold":42,"updated_at":"2026-03-17T14:30:00Z","url":"https://checkout.withflintpay.com/pay/pl_123","version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Payment link with expanded subscription plan","value":{"data":{"completed_count":3,"created_at":"2026-03-17T14:30:00Z","custom_fields":[{"custom_field_type":"dropdown","key":"meal_preference","label":"Meal preference","options":["Vegetarian","Chicken","Fish"],"payment_link_custom_field_id":"plcf_123","required":true}],"description":"Event checkout","event_config":{"event_at":"2026-05-12T19:00:00Z","max_total_quantity":500,"send_ticket_emails":true,"ticket_prefix":"GAL","venue":"Pier 57, New York"},"image":{"alt":"Spring gala","height":900,"url":"https://images.withflintpay.com/ia_spring_gala/original","width":1600},"line_items":[{"is_catalog_item_unavailable":false,"key":"general-admission","name":"General Admission","payment_link_line_item_id":"plli_123","quantity":1,"unit_price_money":{"amount":2500,"currency":"USD"}}],"merchant_id":"mer_123","metadata":{"campaign":"spring-gala"},"name":"Spring Gala","payment_link_id":"pl_123","payment_link_type":"event","payments":{"enabled_payment_options":["card","apple_pay","google_pay"]},"plan_id":"plan_123","status":"active","subscription_plan":{"billing_interval":"monthly","billing_interval_count":1,"created_at":"2026-03-17T14:30:00Z","currency":"USD","line_items":[{"name":"Membership","quantity":1,"subscription_plan_line_item_id":"spli_123","unit_price_money":{"amount":2500,"currency":"USD"}}],"name":"Monthly Membership","plan_id":"plan_123","status":"active","updated_at":"2026-03-17T14:30:00Z"},"total_quantity_sold":42,"updated_at":"2026-03-17T14:30:00Z","url":"https://checkout.withflintpay.com/pay/pl_123","version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/PaymentLinkResponse"}}},"description":"The requested payment link.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"payment link not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment link not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get payment link","tags":["payment_links"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["checkouts.payment_links.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["checkouts.payment_links.read","checkouts.payment_links.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Updates a payment link. To replace line items, custom fields, or delivery methods, send the complete array with `expected_version`.","operationId":"updatePaymentLink","parameters":[{"description":"Flint payment link ID.","in":"path","name":"payment_link_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"description":"Updated public description","event_config":{"venue":"Pier 59, New York"},"expected_version":3,"inactive_message":"Sales are currently paused.","max_completions":100,"payments":{"enabled_payment_options":["card","apple_pay","google_pay"]}},"schema":{"$ref":"#/components/schemas/UpdatePaymentLinkRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"completed_count":3,"created_at":"2026-03-17T14:30:00Z","custom_fields":[{"custom_field_type":"dropdown","key":"meal_preference","label":"Meal preference","options":["Vegetarian","Chicken","Fish"],"payment_link_custom_field_id":"plcf_123","required":true}],"description":"Event checkout","event_config":{"event_at":"2026-05-12T19:00:00Z","max_total_quantity":500,"send_ticket_emails":true,"ticket_prefix":"GAL","venue":"Pier 57, New York"},"image":{"alt":"Spring gala","height":900,"url":"https://images.withflintpay.com/ia_spring_gala/original","width":1600},"line_items":[{"is_catalog_item_unavailable":false,"key":"general-admission","name":"General Admission","payment_link_line_item_id":"plli_123","quantity":1,"unit_price_money":{"amount":2500,"currency":"USD"}}],"merchant_id":"mer_123","metadata":{"campaign":"spring-gala"},"name":"Spring Gala","payment_link_id":"pl_123","payment_link_type":"event","payments":{"enabled_payment_options":["card","apple_pay","google_pay"]},"status":"active","total_quantity_sold":42,"updated_at":"2026-03-17T14:30:00Z","url":"https://checkout.withflintpay.com/pay/pl_123","version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PaymentLinkResponse"}}},"description":"The updated payment link.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"payment link not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment link not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The payment link version changed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update payment link","tags":["payment_links"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_METHODS_NOT_APPLICABLE","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","PAYMENT_LINK_CHANGED","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["checkouts.payment_links.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["checkouts.payment_links.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/payment-links/{payment_link_id}/public":{"get":{"description":"Returns the sanitized buyer-facing payment-link snapshot and a private resolution context for this browser operation.","operationId":"getPaymentLinkPublic","parameters":[{"description":"Flint payment link ID.","in":"path","name":"payment_link_id","required":true,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"merchant_logo":{"alt":"Merchant logo","height":512,"url":"https://images.withflintpay.com/ia_merchant_logo/original","width":512},"merchant_name":"Cedar \u0026 Stone Coffee","payment_link":{"completed_count":3,"custom_fields":[{"custom_field_type":"dropdown","key":"roast_preference","label":"Roast preference","options":["Light","Medium","Dark"],"payment_link_custom_field_id":"plcf_123","required":true}],"description":"Monthly coffee membership","image":{"alt":"Monthly roast box","height":800,"url":"https://images.withflintpay.com/ia_roast_box/original","width":1200},"name":"Roaster's club membership","payment_link_id":"pl_123","payment_link_type":"standard","payments":{"enabled_payment_options":["card","apple_pay","google_pay"]},"plan_id":"plan_01JZEXAMPLEPLAN1234567890","status":"active","version":1},"resolution_context":"plrc_v1.example_signed_resolution_context","resolution_context_expires_at":"2026-05-13T19:00:00Z","resolution_context_start_deadline_at":"2026-05-13T18:58:00Z","subscription_preview":{"billing_interval":"monthly","billing_interval_count":1,"contract_term_months":12,"early_termination_fee_money":{"amount":5000,"currency":"USD"},"plan_image":{"alt":"Monthly roast box","height":800,"url":"https://images.withflintpay.com/ia_roast_box/original","width":1200},"plan_name":"Roaster's club","recurring_total_money":{"amount":2400,"currency":"USD"},"setup_fee_money":{"amount":1000,"currency":"USD"},"trial_period_days":14}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PublicPaymentLinkResponse"}}},"description":"The public payment link and private resolution context.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"payment link not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment link not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[],"summary":"Get public payment link","tags":["payment_links"],"x-flint-error-codes":["PAYMENT_LINK_FULFILLMENT_UNAVAILABLE","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-route-class":"read"}},"/v1/payment-links/{payment_link_id}/resolve":{"post":{"description":"Creates a buyer checkout session from an active payment link. Catalog-backed modifier availability is frozen onto the checkout session and selected modifiers are resolved onto the backing order.","operationId":"resolvePaymentLink","parameters":[{"description":"Flint payment link ID.","in":"path","name":"payment_link_id","required":true,"schema":{"type":"string"}},{"description":"Required idempotency key. Reuse it with the same resolution_context for uncertain retries.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"custom_field_values":{"meal_preference":"Vegetarian"},"modifiers":{"general-admission":{"modifiers":[{"modifier_id":"mod_01JZEXAMPLEMODIFIER123456","quantity":1},{"text":{"modifier_group_id":"mg_01JZEXAMPLEGROUP1234567","value":"Extra hot"}}]}},"quantity_overrides":{"general-admission":2},"resolution_context":"plrc_v1.example_signed_resolution_context"},"schema":{"$ref":"#/components/schemas/ResolvePaymentLinkRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"checkout_access":{"checkout_auth_token":"csauth_123","hosted_url":"https://checkout.withflintpay.com/checkout/cs_123#checkout_token=tok_123"},"checkout_session":{"checkout_session_id":"cs_123","created_at":"2026-03-17T14:30:00Z","customer_collection":{"require_email":true},"delivery_method_ids":null,"delivery_selection_required":false,"merchant_id":"mer_123","metadata":{"campaign":"spring_launch"},"order_id":"ord_123","origin":"api","payments":{"enabled_payment_options":["card","apple_pay","google_pay"],"payment_note":"Thank you for your purchase."},"problems":[],"promotion_config":{"codes_enabled":true},"recovery_mode":false,"redirects":{"cancel_redirect_url":"https://example.com/canceled","success_redirect_url":"https://example.com/success"},"status":"open","surface":"hosted","theme":{"primary_color":"#0f766e","title":"Spring Gala Checkout"},"updated_at":"2026-03-17T14:30:00Z","url":"https://checkout.withflintpay.com/checkout/cs_123#checkout_token=tok_123"},"hosted_checkout":{"checkout_auth_token":"csauth_123","url":"https://checkout.withflintpay.com/checkout/cs_123#checkout_token=tok_123"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ResolvePaymentLinkResponse"}}},"description":"The created buyer checkout session.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"payment link not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment link not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[],"summary":"Resolve payment link","tags":["payment_links"],"x-flint-error-codes":["INVALID_REQUEST","PAYMENT_LINK_FULFILLMENT_UNAVAILABLE","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-route-class":"payment"}},"/v1/payment-method-domains":{"get":{"description":"Returns payment method domains ordered by payment_method_domain_id ascending in the selected Flint environment. Page tokens are opaque, bind to the list parameters, and return a validation error when invalid or mismatched.","operationId":"listPaymentMethodDomains","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodDomainListResponse"}}},"description":"A page of payment method domains.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment method domains are temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List payment method domains","tags":["payment_method_domains"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_PAGE_SIZE","INVALID_PAGE_TOKEN","INVALID_REQUEST","PAYMENT_METHOD_DOMAINS_UNAVAILABLE","RATE_LIMIT_EXCEEDED","UNSUPPORTED_QUERY_PARAM"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["payments.payment_method_domains.read","payments.payment_method_domains.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Registers one exact domain or subdomain for Apple Pay and Google Pay in the selected Flint environment, then validates its wallet readiness.","operationId":"createPaymentMethodDomain","parameters":[{"description":"Optional idempotency key for safe retries. Flint generates and returns one when omitted.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaymentMethodDomainRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodDomainResponse"}}},"description":"The payment method domain registration.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The domain or merchant state conflicts with the requested operation.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment method domains are temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Domain registration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Register payment method domain","tags":["payment_method_domains"],"x-flint-error-codes":["AUTH_REQUIRED","IDEMPOTENCY_CLEAR_FAILED","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","IDEMPOTENCY_LOAD_FAILED","IDEMPOTENCY_PERSIST_FAILED","IDEMPOTENCY_RECOVERY_REQUIRED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_DOMAIN_NAME","INVALID_IDEMPOTENCY_KEY","INVALID_REQUEST","MERCHANT_ACCOUNT_NOT_READY","PAYMENT_METHOD_DOMAINS_UNAVAILABLE","PAYMENT_METHOD_DOMAIN_ALREADY_EXISTS","PAYMENT_METHOD_DOMAIN_REGISTRATION_FAILED","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["payments.payment_method_domains.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/payment-method-domains/{payment_method_domain_id}":{"get":{"description":"Returns one environment-scoped payment method domain and its Apple Pay and Google Pay readiness.","operationId":"getPaymentMethodDomain","parameters":[{"description":"Flint payment method domain ID.","in":"path","name":"payment_method_domain_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodDomainResponse"}}},"description":"The requested payment method domain.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment method domain not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment method domains are temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get payment method domain","tags":["payment_method_domains"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_REQUEST","PAYMENT_METHOD_DOMAINS_UNAVAILABLE","PAYMENT_METHOD_DOMAIN_NOT_FOUND","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["payments.payment_method_domains.read","payments.payment_method_domains.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Sets the domain registration status. Activating the domain also validates Apple Pay and Google Pay readiness.","operationId":"updatePaymentMethodDomain","parameters":[{"description":"Flint payment method domain ID.","in":"path","name":"payment_method_domain_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries. Flint generates and returns one when omitted.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePaymentMethodDomainRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentMethodDomainResponse"}}},"description":"The payment method domain registration.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment method domain not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The domain or merchant state conflicts with the requested operation.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment method domains are temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Domain registration is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update payment method domain","tags":["payment_method_domains"],"x-flint-error-codes":["AUTH_REQUIRED","IDEMPOTENCY_CLEAR_FAILED","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","IDEMPOTENCY_LOAD_FAILED","IDEMPOTENCY_PERSIST_FAILED","IDEMPOTENCY_RECOVERY_REQUIRED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_IDEMPOTENCY_KEY","INVALID_REQUEST","INVALID_STATUS","MERCHANT_ACCOUNT_NOT_READY","PAYMENT_METHOD_DOMAINS_UNAVAILABLE","PAYMENT_METHOD_DOMAIN_NOT_FOUND","PAYMENT_METHOD_DOMAIN_OPERATION_IN_PROGRESS","PAYMENT_METHOD_DOMAIN_REGISTRATION_FAILED","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["payments.payment_method_domains.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/payment-methods":{"get":{"description":"Returns saved payment methods for the merchant, optionally filtered to a customer. By default, only active payment methods are returned.","operationId":"listPaymentMethods","parameters":[{"description":"Optional Flint customer ID filter.","in":"query","name":"customer_id","required":false,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by payment method type.","in":"query","name":"type","required":false,"schema":{"enum":["card"],"type":"string","x-enum-descriptions":["Card."],"x-flint-enum":"closed"}},{"description":"Filter by payment method status.","in":"query","name":"status","required":false,"schema":{"enum":["active","pending","expired","removed","failed"],"type":"string","x-enum-descriptions":["Active.","Pending.","Expired.","Removed.","Failed."],"x-flint-enum":"open"}},{"description":"Checkout session ID when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"card":{"brand":"visa","exp_month":12,"exp_year":2030,"last4":"4242"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","payment_method_id":"pm_123","status":"active","type":"card","updated_at":"2026-03-17T14:30:00Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PaymentMethodListResponse"}}},"description":"A page of payment methods.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List payment methods","tags":["payment_methods"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["payments.payment_methods.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["payments.payment_methods.read","payments.payment_methods.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Initiates saving a payment method and returns the client setup payload needed to complete setup on the frontend.","operationId":"savePaymentMethod","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"customer_id":"cus_123","type":"card"},"schema":{"$ref":"#/components/schemas/SavePaymentMethodRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"client_setup":{"stripe":{"account_id":"acct_123","publishable_key":"pk_test_123","setup_intent":{"client_secret":"seti_secret_123","stripe_js_call":"confirm_setup"}}},"payment_method":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","payment_method_id":"pm_123","status":"pending","type":"card","updated_at":"2026-03-17T14:30:00Z"}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SavePaymentMethodResponse"}}},"description":"The initiated payment method setup record and any client-side setup details.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Save payment method","tags":["payment_methods"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["payments.payment_methods.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["payments.payment_methods.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/payment-methods/{payment_method_id}":{"delete":{"description":"Soft-removes a saved payment method so it can no longer be used for future payments.","operationId":"removePaymentMethod","parameters":[{"description":"Flint payment method ID.","in":"path","name":"payment_method_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"success":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ActionResponse"}}},"description":"Removal acknowledged.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"payment method not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment method not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Remove payment method","tags":["payment_methods"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["payments.payment_methods.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["payments.payment_methods.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"},"get":{"description":"Returns a single payment method by ID.","operationId":"getPaymentMethod","parameters":[{"description":"Flint payment method ID.","in":"path","name":"payment_method_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: customer. Expansion requires payments.payment_methods.read plus customers.read. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=customer\u0026expand=customer, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["customer"],"type":"string","x-enum-descriptions":["Customer."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Checkout session ID when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-ID","required":false,"schema":{"type":"string"}},{"description":"Checkout session secret when authenticating as a checkout session.","in":"header","name":"X-Checkout-Session-Secret","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Payment method","value":{"data":{"card":{"brand":"visa","exp_month":12,"exp_year":2030,"last4":"4242"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","payment_method_id":"pm_123","status":"active","type":"card","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Payment method with expanded customer","value":{"data":{"card":{"brand":"visa","exp_month":12,"exp_year":2030,"last4":"4242"},"created_at":"2026-03-17T14:30:00Z","customer":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","email":"jane@example.com","name":"Jane Doe","phone":"+14155552671","updated_at":"2026-03-17T14:30:00Z"},"customer_id":"cus_123","merchant_id":"mer_123","payment_method_id":"pm_123","status":"active","type":"card","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/PaymentMethodResponse"}}},"description":"The requested payment method.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"payment method not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment method not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"CheckoutSessionIDHeader":[],"CheckoutSessionSecretHeader":[]},{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get payment method","tags":["payment_methods"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["payments.payment_methods.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["payments.payment_methods.read","payments.payment_methods.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/payment-methods/{payment_method_id}/set-default":{"post":{"description":"Sets the default payment method for the payment method's owning customer.","operationId":"setDefaultPaymentMethod","parameters":[{"description":"Flint payment method ID.","in":"path","name":"payment_method_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"card":{"brand":"visa","exp_month":12,"exp_year":2030,"last4":"4242"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","payment_method_id":"pm_123","status":"active","type":"card","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PaymentMethodResponse"}}},"description":"The payment method that is now the default.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"payment method not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payment method not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Set default payment method","tags":["payment_methods"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["payments.payment_methods.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["payments.payment_methods.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/payout-settings":{"get":{"description":"Returns payout settings that control default payout behavior for the authenticated merchant.","operationId":"getPayoutSettings","parameters":[{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutSettingsResponse"}}},"description":"Payout settings for the authenticated merchant.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get payout settings","tags":["money_movement"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["money_movement.payout_settings.read","money_movement.payout_settings.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Updates mutable payout settings for the authenticated merchant. Safe to retry with the same Idempotency-Key.","operationId":"updatePayoutSettings","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePayoutSettingsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutSettingsResponse"}}},"description":"The updated payout settings.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Capability or state blocked this money movement operation.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update payout settings","tags":["money_movement"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["money_movement.payout_settings.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/payout-settings/destinations":{"get":{"description":"Returns a paginated list of payout destinations available to the authenticated merchant.","operationId":"listPayoutDestinations","parameters":[{"description":"Optional 3-letter currency filter.","in":"query","name":"currency","required":false,"schema":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"}},{"description":"Optional payout destination type filter.","in":"query","name":"type","required":false,"schema":{"enum":["bank_account","debit_card"],"type":"string","x-enum-descriptions":["Bank account.","Debit card."],"x-flint-enum":"closed"}},{"description":"Optional payout destination status filter.","in":"query","name":"status","required":false,"schema":{"enum":["pending","active","verification_required","disabled","deleted","failed"],"type":"string","x-enum-descriptions":["Pending.","Active.","Verification required.","Disabled.","Deleted.","Failed."],"x-flint-enum":"open"}},{"description":"Optional available payout method filter.","in":"query","name":"available_payout_method","required":false,"schema":{"enum":["standard"],"type":"string","x-enum-descriptions":["Standard."],"x-flint-enum":"closed"}},{"description":"Whether to return only destinations that are the default for their currency.","in":"query","name":"default_for_currency","required":false,"schema":{"type":"boolean"}},{"description":"Whether to include deleted payout destinations.","in":"query","name":"include_deleted","required":false,"schema":{"type":"boolean"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutDestinationListResponse"}}},"description":"Payout destinations for the authenticated merchant.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List payout destinations","tags":["money_movement"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["money_movement.payout_settings.read","money_movement.payout_settings.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/payout-settings/destinations/{payout_destination_id}":{"delete":{"description":"Disables an eligible payout destination and returns its final state. Safe to retry with the same Idempotency-Key.","operationId":"deletePayoutDestination","parameters":[{"description":"Flint payout destination ID.","in":"path","name":"payout_destination_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePayoutDestinationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutDestinationResponse"}}},"description":"The resulting payout destination.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Capability or state blocked this money movement operation.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Delete or disable a payout destination","tags":["money_movement"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["money_movement.payout_settings.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"},"get":{"description":"Returns one payout destination by ID.","operationId":"getPayoutDestination","parameters":[{"description":"Flint payout destination ID.","in":"path","name":"payout_destination_id","required":true,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutDestinationResponse"}}},"description":"The requested payout destination.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get a payout destination","tags":["money_movement"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["money_movement.payout_settings.read","money_movement.payout_settings.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Updates mutable metadata and settings for a payout destination. Safe to retry with the same Idempotency-Key.","operationId":"updatePayoutDestination","parameters":[{"description":"Flint payout destination ID.","in":"path","name":"payout_destination_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePayoutDestinationRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutDestinationResponse"}}},"description":"The updated payout destination.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Capability or state blocked this money movement operation.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update payout destination metadata","tags":["money_movement"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["money_movement.payout_settings.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/payouts":{"get":{"description":"Returns a paginated list of payouts with optional filters for status, currency, destination, method, and timing.","operationId":"listPayouts","parameters":[{"description":"Optional 3-letter currency filter.","in":"query","name":"currency","required":false,"schema":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"}},{"description":"Optional payout method filter.","in":"query","name":"method","required":false,"schema":{"enum":["standard"],"type":"string","x-enum-descriptions":["Standard."],"x-flint-enum":"closed"}},{"description":"Optional Flint balance source type filter.","in":"query","name":"balance_source_type","required":false,"schema":{"enum":["card","bank_account","fpx"],"type":"string","x-enum-descriptions":["Card.","Bank account.","Fpx."],"x-flint-enum":"closed"}},{"description":"Optional payout destination ID filter.","in":"query","name":"payout_destination_id","required":false,"schema":{"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search across payout ID, external reference ID, description, and statement descriptor.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Optional payout status filter.","in":"query","name":"status","required":false,"schema":{"enum":["pending","in_transit","paid","failed","canceled"],"type":"string","x-enum-descriptions":["Pending.","In transit.","Paid.","Failed.","Canceled."],"x-flint-enum":"open"}},{"description":"Only include payouts created at or after this RFC3339 timestamp.","in":"query","name":"created_after","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Only include payouts created at or before this RFC3339 timestamp.","in":"query","name":"created_before","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Only include payouts arriving at or after this RFC3339 timestamp.","in":"query","name":"arrival_after","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Only include payouts arriving at or before this RFC3339 timestamp.","in":"query","name":"arrival_before","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutListResponse"}}},"description":"Payouts for the authenticated merchant.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List payouts","tags":["money_movement"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["money_movement.payouts.read","money_movement.payouts.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates a payout from an available balance to an eligible payout destination. Safe to retry with the same Idempotency-Key.","operationId":"createPayout","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePayoutRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutResponse"}}},"description":"The created payout.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Capability or state blocked this money movement operation.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create a payout","tags":["money_movement"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["money_movement.payouts.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/payouts/{payout_id}":{"get":{"description":"Returns one payout by ID, with optional related payout and payout destination expansions.","operationId":"getPayout","parameters":[{"description":"Flint payout ID.","in":"path","name":"payout_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: original_payout, payout_destination, reversed_by_payout. Expansion requires money_movement.payouts.read plus the read scope for each expanded resource. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=original_payout\u0026expand=payout_destination, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["original_payout","payout_destination","reversed_by_payout"],"type":"string","x-enum-descriptions":["Original payout.","Payout destination.","Reversed by payout."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Payout","value":{"data":{"amount_money":{"amount":25000,"currency":"USD"},"arrival_at":"2026-03-20T09:00:00Z","balance_source_type":"payments","created_at":"2026-03-17T14:30:00Z","currency":"USD","description":"Weekly payout","fee_amount_status":"final","fee_money":{"amount":0,"currency":"USD"},"held_money":{"amount":0,"currency":"USD"},"initiated_by":"merchant","merchant_id":"mer_123","metadata":{"batch":"weekly"},"method":"standard","net_money":{"amount":25000,"currency":"USD"},"payout_destination_id":"pdest_123","payout_id":"po_123","reversal_status":"none","status":"paid","updated_at":"2026-03-20T09:00:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Payout with expanded relationships","value":{"data":{"amount_money":{"amount":25000,"currency":"USD"},"arrival_at":"2026-03-20T09:00:00Z","balance_source_type":"payments","created_at":"2026-03-17T14:30:00Z","currency":"USD","description":"Weekly payout","fee_amount_status":"final","fee_money":{"amount":0,"currency":"USD"},"held_money":{"amount":0,"currency":"USD"},"initiated_by":"merchant","merchant_id":"mer_123","metadata":{"batch":"weekly"},"method":"standard","net_money":{"amount":25000,"currency":"USD"},"original_payout":{"amount_money":{"amount":25000,"currency":"USD"},"arrival_at":"2026-03-15T09:00:00Z","balance_source_type":"payments","created_at":"2026-03-12T14:30:00Z","currency":"USD","method":"standard","payout_destination_id":"pdest_123","payout_id":"po_original","reversal_status":"partially_reversed","status":"paid","updated_at":"2026-03-15T09:00:00Z"},"original_payout_id":"po_original","payout_destination":{"available_payout_methods":["standard"],"bank_name":"Example Bank","country":"US","created_at":"2026-03-15T14:30:00Z","currency":"USD","default_for_currency":true,"last4":"6789","payout_destination_id":"pdest_123","status":"active","type":"bank_account","updated_at":"2026-03-17T14:30:00Z"},"payout_destination_id":"pdest_123","payout_id":"po_123","reversal_status":"none","reversed_by_payout":{"amount_money":{"amount":5000,"currency":"USD"},"arrival_at":"2026-03-22T09:00:00Z","balance_source_type":"payments","created_at":"2026-03-19T14:30:00Z","currency":"USD","method":"standard","payout_destination_id":"pdest_123","payout_id":"po_reversal","reversal_status":"none","status":"paid","updated_at":"2026-03-22T09:00:00Z"},"reversed_by_payout_id":"po_reversal","status":"paid","updated_at":"2026-03-20T09:00:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/PayoutResponse"}}},"description":"The requested payout.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payout not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get a payout","tags":["money_movement"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["money_movement.payouts.read","money_movement.payouts.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/payouts/{payout_id}/cancel":{"post":{"description":"Cancels an eligible payout before it leaves Flint-controlled processing and returns the resulting payout.","operationId":"cancelPayout","parameters":[{"description":"Flint payout ID.","in":"path","name":"payout_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelPayoutRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutResponse"}}},"description":"The canceled payout.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Capability or state blocked this money movement operation.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Cancel a payout","tags":["money_movement"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["money_movement.payouts.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/payouts/{payout_id}/entries":{"get":{"description":"Lists the authoritative balance-transaction allocations for a payout in ascending occurrence order. A paid payout returns an unavailable error instead of incomplete or inferred entries.","operationId":"listPayoutEntries","parameters":[{"description":"Flint payout ID.","in":"path","name":"payout_id","required":true,"schema":{"type":"string"}},{"description":"Number of payout entries to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque token returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutEntryListResponse"}}},"description":"Payout entries for the requested payout.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Payout not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authoritative payout entries are temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List payout entries","tags":["money_movement"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_PAGE_SIZE","INVALID_PAGE_TOKEN","INVALID_REQUEST","PAYOUT_ENTRIES_UNAVAILABLE","PAYOUT_NOT_FOUND","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["money_movement.payouts.read","money_movement.payouts.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/products":{"get":{"description":"Returns a paginated list of products for the authenticated merchant.","operationId":"listProducts","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by product type.","in":"query","name":"product_type","required":false,"schema":{"enum":["physical","service","fee","digital"],"type":"string","x-enum-descriptions":["Physical.","Service.","Fee.","Digital."],"x-flint-enum":"closed"}},{"description":"Filter by product status.","in":"query","name":"status","required":false,"schema":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"}},{"description":"Filter by category handle.","in":"query","name":"category_handle","required":false,"schema":{"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Filter by exact variant SKU.","in":"query","name":"sku","required":false,"schema":{"type":"string"}},{"description":"Search across product ID, external reference ID, name, description, and SKU.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Filter products with at least one non-deleted variant assigned to this delivery profile.","in":"query","name":"delivery_profile_id","required":false,"schema":{"type":"string"}},{"description":"Filter by aggregated delivery readiness across non-deleted variants.","in":"query","name":"delivery_configuration_status","required":false,"schema":{"enum":["configured","action_required","not_applicable"],"type":"string","x-enum-descriptions":["Configured.","Action required.","Not applicable."],"x-flint-enum":"open"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["name","created_at","updated_at"],"type":"string","x-enum-descriptions":["Name.","Created at.","Updated at."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"RFC3339 lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 lower bound for updated_at.","in":"query","name":"updated_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for updated_at.","in":"query","name":"updated_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"active_variant_count":1,"available_for_sale":true,"categories":[{"category_id":"ctg_tickets","handle":"tickets","name":"Tickets"},{"category_id":"ctg_events","handle":"events","name":"Events"}],"created_at":"2026-03-17T14:30:00Z","default_variant_id":"var_123","delivery_configuration_status":"configured","images":[],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"modifier_set_id":null,"name":"General Admission","option_count":0,"options":[],"price_range":{"max_unit_price_money":{"amount":2500,"currency":"USD"},"min_unit_price_money":{"amount":2500,"currency":"USD"}},"product_id":"prod_123","product_type":"physical","status":"active","updated_at":"2026-03-17T14:30:00Z","variant_count":1,"version":1}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ProductListResponse"}}},"description":"A page of products.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List products","tags":["products"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.products.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.products.read","commerce.products.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates a product for the authenticated merchant.","operationId":"createProduct","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"categories":["tickets","events"],"default_variant":{"sku":"ga-001","unit_price_money":{"amount":2500,"currency":"USD"}},"metadata":{"event_id":"evt_123"},"name":"General Admission","product_type":"physical"},"schema":{"$ref":"#/components/schemas/CreateProductRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"active_variant_count":1,"available_for_sale":true,"categories":[{"category_id":"ctg_tickets","handle":"tickets","name":"Tickets"},{"category_id":"ctg_events","handle":"events","name":"Events"}],"created_at":"2026-03-17T14:30:00Z","default_variant_id":"var_123","delivery_configuration_status":"configured","images":[],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"modifier_set_id":null,"name":"General Admission","option_count":0,"options":[],"price_range":{"max_unit_price_money":{"amount":2500,"currency":"USD"},"min_unit_price_money":{"amount":2500,"currency":"USD"}},"product_id":"prod_123","product_type":"physical","status":"active","updated_at":"2026-03-17T14:30:00Z","variant_count":1,"version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ProductResponse"}}},"description":"The created product.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The image source is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create product","tags":["products"],"x-flint-error-codes":["ACTIVE_OPTIONS_REQUIRED","AUTH_REQUIRED","DUPLICATE_CLIENT_OPTION_KEY","DUPLICATE_CLIENT_VALUE_KEY","DUPLICATE_IMAGE_EXTERNAL_REFERENCE_ID","DUPLICATE_IMAGE_SOURCE","DUPLICATE_VALUE","FULFILLMENT_PROFILE_UNAVAILABLE","IMAGE_ANIMATION_UNSUPPORTED","IMAGE_ASSET_NOT_ATTACHABLE","IMAGE_ASSET_NOT_FOUND","IMAGE_DIMENSIONS_EXCEEDED","IMAGE_FORMAT_UNSUPPORTED","IMAGE_GALLERY_LIMIT_EXCEEDED","IMAGE_INGESTION_COUNT_EXCEEDED","IMAGE_INGESTION_EXPIRED","IMAGE_INGESTION_IN_PROGRESS","IMAGE_INGESTION_RESTART_REQUIRED","IMAGE_NOT_ATTACHABLE","IMAGE_OWNER_NOT_MUTABLE","IMAGE_PIXEL_BUDGET_EXCEEDED","IMAGE_PROCESSING_CAPACITY_EXCEEDED","IMAGE_PROCESSING_FAILED","IMAGE_PROCESSING_TIMEOUT","IMAGE_SOURCE_FETCH_FAILED","IMAGE_SOURCE_NOT_PUBLIC","IMAGE_SOURCE_TIMEOUT","IMAGE_SOURCE_TOO_LARGE","IMAGE_SOURCE_UNAVAILABLE","IMAGE_SOURCE_URL_INVALID","IMAGE_STORAGE_QUOTA_EXCEEDED","IMAGE_URL_INVALID","IMAGE_URL_MUST_BE_CANONICAL","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_IMAGE_ALT","INVALID_IMAGE_EXTERNAL_REFERENCE_ID","INVALID_IMAGE_GALLERY","INVALID_OPTION_POSITION","INVALID_OPTION_STATUS","INVALID_OPTION_VALUE_POSITION","INVALID_OPTION_VALUE_STATUS","INVALID_REQUEST","MIXED_VARIANT_CURRENCIES","NORMALIZED_IMAGE_TOO_LARGE","OPTION_REQUIRED","OPTION_VALUES_REQUIRED","OPTION_VALUE_REFERENCE_REQUIRED","OPTION_VALUE_REQUIRED","OPTION_VALUE_TOO_LONG","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","SERVER_GENERATED_ID","SERVICE_UNAVAILABLE","UNKNOWN_CLIENT_OPTION_VALUE","VALUE_REQUIRED","VARIANT_OPTION_COMBINATION_ALREADY_EXISTS"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.products.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.products.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/products/{product_id}":{"delete":{"description":"Archives a product and returns its final state.","operationId":"deleteProduct","parameters":[{"description":"Flint product ID.","in":"path","name":"product_id","required":true,"schema":{"type":"string"}},{"description":"Optional product version last read by the caller.","in":"query","name":"expected_version","required":false,"schema":{"format":"uint64","minimum":1,"type":"integer"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"active_variant_count":0,"available_for_sale":false,"created_at":"2026-03-17T14:30:00Z","delivery_configuration_status":"configured","images":[],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"modifier_set_id":null,"name":"General Admission","option_count":0,"options":[],"product_id":"prod_123","product_type":"physical","status":"archived","updated_at":"2026-03-17T14:30:00Z","variant_count":0,"version":2},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ProductResponse"}}},"description":"The archived product.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"product not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Product not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Retire product","tags":["products"],"x-flint-error-codes":["AUTH_REQUIRED","CONCURRENT_MODIFICATION","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_EXPECTED_VERSION","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","VARIANT_IN_ACTIVE_BUNDLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.products.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.products.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Returns a single product by ID.","operationId":"getProduct","parameters":[{"description":"Flint product ID.","in":"path","name":"product_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: modifier_set. Expand the attached modifier set. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=modifier_set\u0026expand=modifier_set, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["modifier_set"],"type":"string","x-enum-descriptions":["Modifier set."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Resource","value":{"data":{"active_variant_count":1,"available_for_sale":true,"categories":[{"category_id":"ctg_tickets","handle":"tickets","name":"Tickets"},{"category_id":"ctg_events","handle":"events","name":"Events"}],"created_at":"2026-03-17T14:30:00Z","default_variant_id":"var_123","delivery_configuration_status":"configured","images":[],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"modifier_set_id":null,"name":"General Admission","option_count":0,"options":[],"price_range":{"max_unit_price_money":{"amount":2500,"currency":"USD"},"min_unit_price_money":{"amount":2500,"currency":"USD"}},"product_id":"prod_123","product_type":"physical","status":"active","updated_at":"2026-03-17T14:30:00Z","variant_count":1,"version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Resource with modifier set","value":{"data":{"active_variant_count":1,"available_for_sale":true,"categories":[{"category_id":"ctg_tickets","handle":"tickets","name":"Tickets"},{"category_id":"ctg_events","handle":"events","name":"Events"}],"created_at":"2026-03-17T14:30:00Z","default_variant_id":"var_123","delivery_configuration_status":"configured","images":[],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"modifier_set":{"modifier_groups":[],"modifier_set_id":"ms_01J00000000000000000000000","name":"Engraving","status":"active","version":1},"modifier_set_id":"ms_01J00000000000000000000000","name":"General Admission","option_count":0,"options":[],"price_range":{"max_unit_price_money":{"amount":2500,"currency":"USD"},"min_unit_price_money":{"amount":2500,"currency":"USD"}},"product_id":"prod_123","product_type":"physical","status":"active","updated_at":"2026-03-17T14:30:00Z","variant_count":1,"version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/ProductResponse"}}},"description":"The requested product.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"product not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Product not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get product","tags":["products"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.products.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.products.read","commerce.products.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Applies a sparse update to product-parent fields. When categories is present, it replaces the full category list; send an empty array to clear categories. Sellable price, SKU, and inventory live on variants.","operationId":"updateProduct","parameters":[{"description":"Flint product ID.","in":"path","name":"product_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"categories":["vip","events"],"expected_version":1,"name":"VIP Admission","status":"inactive"},"schema":{"$ref":"#/components/schemas/UpdateProductRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"active_variant_count":1,"available_for_sale":true,"categories":[{"category_id":"ctg_tickets","handle":"tickets","name":"Tickets"},{"category_id":"ctg_events","handle":"events","name":"Events"}],"created_at":"2026-03-17T14:30:00Z","default_variant_id":"var_123","delivery_configuration_status":"configured","images":[],"merchant_id":"mer_123","metadata":{"event_id":"evt_123"},"modifier_set_id":null,"name":"General Admission","option_count":0,"options":[],"price_range":{"max_unit_price_money":{"amount":2500,"currency":"USD"},"min_unit_price_money":{"amount":2500,"currency":"USD"}},"product_id":"prod_123","product_type":"physical","status":"active","updated_at":"2026-03-17T14:30:00Z","variant_count":1,"version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ProductResponse"}}},"description":"The updated product.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"product not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Product not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The image source is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update product","tags":["products"],"x-flint-error-codes":["ACTIVE_OPTION_SELECTOR_COLLAPSE","ACTIVE_VARIANTS_REQUIRE_OPTION_BACKFILL","AUTH_REQUIRED","CONCURRENT_MODIFICATION","DUPLICATE_IMAGE_EXTERNAL_REFERENCE_ID","DUPLICATE_IMAGE_SOURCE","DUPLICATE_OPTION","DUPLICATE_OPTION_NAME","DUPLICATE_OPTION_VALUE","DUPLICATE_VALUE","EXPECTED_VERSION_REQUIRED","IMAGE_ANIMATION_UNSUPPORTED","IMAGE_ASSET_NOT_ATTACHABLE","IMAGE_ASSET_NOT_FOUND","IMAGE_DIMENSIONS_EXCEEDED","IMAGE_FORMAT_UNSUPPORTED","IMAGE_GALLERY_LIMIT_EXCEEDED","IMAGE_INGESTION_COUNT_EXCEEDED","IMAGE_INGESTION_EXPIRED","IMAGE_INGESTION_IN_PROGRESS","IMAGE_INGESTION_RESTART_REQUIRED","IMAGE_NOT_ATTACHABLE","IMAGE_OWNER_NOT_MUTABLE","IMAGE_PIXEL_BUDGET_EXCEEDED","IMAGE_PROCESSING_CAPACITY_EXCEEDED","IMAGE_PROCESSING_FAILED","IMAGE_PROCESSING_TIMEOUT","IMAGE_SOURCE_FETCH_FAILED","IMAGE_SOURCE_NOT_PUBLIC","IMAGE_SOURCE_TIMEOUT","IMAGE_SOURCE_TOO_LARGE","IMAGE_SOURCE_UNAVAILABLE","IMAGE_SOURCE_URL_INVALID","IMAGE_STORAGE_QUOTA_EXCEEDED","IMAGE_URL_INVALID","IMAGE_URL_MUST_BE_CANONICAL","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_CATEGORIES","INVALID_EXPECTED_VERSION","INVALID_IMAGE_ALT","INVALID_IMAGE_EXTERNAL_REFERENCE_ID","INVALID_IMAGE_GALLERY","INVALID_OPTIONS","INVALID_OPTION_POSITION","INVALID_OPTION_STATUS","INVALID_OPTION_VALUE_POSITION","INVALID_OPTION_VALUE_STATUS","INVALID_REQUEST","NORMALIZED_IMAGE_TOO_LARGE","OPTION_REQUIRED","OPTION_VALUES_REQUIRED","OPTION_VALUE_REQUIRED","OPTION_VALUE_TOO_LONG","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","UNKNOWN_OPTION","UNKNOWN_OPTION_VALUE","VALUE_REQUIRED","VARIANT_IN_ACTIVE_BUNDLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.products.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.products.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/products/{product_id}/options":{"get":{"description":"List product options.","operationId":"listProductOptions","parameters":[{"description":"Flint product ID.","in":"path","name":"product_id","required":true,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by option status.","in":"query","name":"status","required":false,"schema":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ProductOptionListResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List product options","tags":["products"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.products.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.products.read","commerce.products.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/products/{product_id}/options/{option_id}":{"get":{"description":"Get product option.","operationId":"getProductOption","parameters":[{"description":"Flint product ID.","in":"path","name":"product_id","required":true,"schema":{"type":"string"}},{"description":"Flint product option ID.","in":"path","name":"option_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-03-17T14:30:00Z","name":"Seat","option_id":"opt_123","position":0,"product_id":"prod_123","status":"active","updated_at":"2026-03-17T14:30:00Z","values":[{"created_at":"2026-03-17T14:30:00Z","option_value_id":"optval_123","position":0,"status":"active","updated_at":"2026-03-17T14:30:00Z","value":"Balcony"}]},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ProductOptionResponse"}}},"description":"The product option.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get product option","tags":["products"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.products.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.products.read","commerce.products.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/products/{product_id}/variants":{"get":{"description":"List product variants.","operationId":"listProductVariants","parameters":[{"description":"Flint product ID.","in":"path","name":"product_id","required":true,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by variant status.","in":"query","name":"status","required":false,"schema":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search across variant ID, external reference ID, name, SKU, and barcode.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["position","created_at","updated_at","unit_price"],"type":"string","x-enum-descriptions":["Position.","Created at.","Updated at.","Unit price."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"Filter by assigned delivery profile ID.","in":"query","name":"delivery_profile_id","required":false,"schema":{"type":"string"}},{"description":"Filter by delivery readiness.","in":"query","name":"delivery_configuration_status","required":false,"schema":{"enum":["configured","action_required","not_applicable"],"type":"string","x-enum-descriptions":["Configured.","Action required.","Not applicable."],"x-flint-enum":"open"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ProductVariantListResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List product variants","tags":["products"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.products.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.products.read","commerce.products.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Create product variant.","operationId":"createProductVariant","parameters":[{"description":"Flint product ID.","in":"path","name":"product_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"variant":{"sku":"ga-balcony-001","unit_price_money":{"amount":2500,"currency":"USD"}}},"schema":{"$ref":"#/components/schemas/CreateProductVariantRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"available_for_sale":true,"created_at":"2026-03-17T14:30:00Z","delivery_configuration_status":"configured","effective_images":[],"images":[],"images_inherited":true,"inventory_tracking":"not_tracked","merchant_id":"mer_123","modifier_set_id":null,"position":0,"product_id":"prod_123","status":"active","unit_price_money":{"amount":2500,"currency":"USD"},"updated_at":"2026-03-17T14:30:00Z","variant_id":"var_123","version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ProductVariantResponse"}}},"description":"The created product variant.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The image source is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create product variant","tags":["products"],"x-flint-error-codes":["AUTH_REQUIRED","DUPLICATE_IMAGE_EXTERNAL_REFERENCE_ID","DUPLICATE_IMAGE_SOURCE","FULFILLMENT_PROFILE_UNAVAILABLE","IMAGE_ANIMATION_UNSUPPORTED","IMAGE_ASSET_NOT_ATTACHABLE","IMAGE_ASSET_NOT_FOUND","IMAGE_DIMENSIONS_EXCEEDED","IMAGE_FORMAT_UNSUPPORTED","IMAGE_GALLERY_LIMIT_EXCEEDED","IMAGE_INGESTION_COUNT_EXCEEDED","IMAGE_INGESTION_EXPIRED","IMAGE_INGESTION_IN_PROGRESS","IMAGE_INGESTION_RESTART_REQUIRED","IMAGE_NOT_ATTACHABLE","IMAGE_OWNER_NOT_MUTABLE","IMAGE_PIXEL_BUDGET_EXCEEDED","IMAGE_PROCESSING_CAPACITY_EXCEEDED","IMAGE_PROCESSING_FAILED","IMAGE_PROCESSING_TIMEOUT","IMAGE_SOURCE_FETCH_FAILED","IMAGE_SOURCE_NOT_PUBLIC","IMAGE_SOURCE_TIMEOUT","IMAGE_SOURCE_TOO_LARGE","IMAGE_SOURCE_UNAVAILABLE","IMAGE_SOURCE_URL_INVALID","IMAGE_STORAGE_QUOTA_EXCEEDED","IMAGE_URL_INVALID","IMAGE_URL_MUST_BE_CANONICAL","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_IMAGE_ALT","INVALID_IMAGE_EXTERNAL_REFERENCE_ID","INVALID_IMAGE_GALLERY","INVALID_REQUEST","NORMALIZED_IMAGE_TOO_LARGE","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.products.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.products.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/products/{product_id}/variants/{variant_id}":{"delete":{"description":"Retire product variant.","operationId":"deleteProductVariant","parameters":[{"description":"Flint product ID.","in":"path","name":"product_id","required":true,"schema":{"type":"string"}},{"description":"Flint product variant ID.","in":"path","name":"variant_id","required":true,"schema":{"type":"string"}},{"description":"Optional product variant version last read by the caller.","in":"query","name":"expected_version","required":false,"schema":{"format":"uint64","minimum":1,"type":"integer"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"available_for_sale":false,"created_at":"2026-03-17T14:30:00Z","delivery_configuration_status":"configured","effective_images":[],"images":[],"images_inherited":true,"inventory_tracking":"not_tracked","merchant_id":"mer_123","modifier_set_id":null,"position":0,"product_id":"prod_123","status":"archived","unit_price_money":{"amount":2500,"currency":"USD"},"updated_at":"2026-03-17T14:35:00Z","variant_id":"var_123","version":2},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ProductVariantResponse"}}},"description":"The archived product variant.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Retire product variant","tags":["products"],"x-flint-error-codes":["AUTH_REQUIRED","CONCURRENT_MODIFICATION","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_EXPECTED_VERSION","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","VARIANT_IN_ACTIVE_BUNDLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.products.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.products.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Get product variant.","operationId":"getProductVariant","parameters":[{"description":"Flint product ID.","in":"path","name":"product_id","required":true,"schema":{"type":"string"}},{"description":"Flint product variant ID.","in":"path","name":"variant_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: modifier_set. Expand the attached modifier set. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=modifier_set\u0026expand=modifier_set, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["modifier_set"],"type":"string","x-enum-descriptions":["Modifier set."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Resource","value":{"data":{"available_for_sale":true,"created_at":"2026-03-17T14:30:00Z","delivery_configuration_status":"configured","effective_images":[],"images":[],"images_inherited":true,"inventory_tracking":"not_tracked","merchant_id":"mer_123","modifier_set_id":null,"position":0,"product_id":"prod_123","status":"active","unit_price_money":{"amount":2500,"currency":"USD"},"updated_at":"2026-03-17T14:30:00Z","variant_id":"var_123","version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Resource with modifier set","value":{"data":{"available_for_sale":true,"created_at":"2026-03-17T14:30:00Z","delivery_configuration_status":"configured","effective_images":[],"images":[],"images_inherited":true,"inventory_tracking":"not_tracked","merchant_id":"mer_123","modifier_set":{"modifier_groups":[],"modifier_set_id":"ms_01J00000000000000000000000","name":"Engraving","status":"active","version":1},"modifier_set_id":"ms_01J00000000000000000000000","position":0,"product_id":"prod_123","status":"active","unit_price_money":{"amount":2500,"currency":"USD"},"updated_at":"2026-03-17T14:30:00Z","variant_id":"var_123","version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/ProductVariantResponse"}}},"description":"The product variant.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get product variant","tags":["products"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.products.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.products.read","commerce.products.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Update product variant.","operationId":"updateProductVariant","parameters":[{"description":"Flint product ID.","in":"path","name":"product_id","required":true,"schema":{"type":"string"}},{"description":"Flint product variant ID.","in":"path","name":"variant_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"expected_version":1,"name":"Balcony admission"},"schema":{"$ref":"#/components/schemas/UpdateProductVariantRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"available_for_sale":true,"created_at":"2026-03-17T14:30:00Z","delivery_configuration_status":"configured","effective_images":[],"images":[],"images_inherited":true,"inventory_tracking":"not_tracked","merchant_id":"mer_123","modifier_set_id":null,"name":"Balcony admission","position":0,"product_id":"prod_123","status":"active","unit_price_money":{"amount":2500,"currency":"USD"},"updated_at":"2026-03-17T14:35:00Z","variant_id":"var_123","version":2},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ProductVariantResponse"}}},"description":"The updated product variant.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The image source is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update product variant","tags":["products"],"x-flint-error-codes":["AUTH_REQUIRED","CONCURRENT_MODIFICATION","DUPLICATE_IMAGE_EXTERNAL_REFERENCE_ID","DUPLICATE_IMAGE_SOURCE","EXPECTED_VERSION_REQUIRED","FULFILLMENT_PROFILE_UNAVAILABLE","IMAGE_ANIMATION_UNSUPPORTED","IMAGE_ASSET_NOT_ATTACHABLE","IMAGE_ASSET_NOT_FOUND","IMAGE_DIMENSIONS_EXCEEDED","IMAGE_FORMAT_UNSUPPORTED","IMAGE_GALLERY_LIMIT_EXCEEDED","IMAGE_INGESTION_COUNT_EXCEEDED","IMAGE_INGESTION_EXPIRED","IMAGE_INGESTION_IN_PROGRESS","IMAGE_INGESTION_RESTART_REQUIRED","IMAGE_NOT_ATTACHABLE","IMAGE_OWNER_NOT_MUTABLE","IMAGE_PIXEL_BUDGET_EXCEEDED","IMAGE_PROCESSING_CAPACITY_EXCEEDED","IMAGE_PROCESSING_FAILED","IMAGE_PROCESSING_TIMEOUT","IMAGE_SOURCE_FETCH_FAILED","IMAGE_SOURCE_NOT_PUBLIC","IMAGE_SOURCE_TIMEOUT","IMAGE_SOURCE_TOO_LARGE","IMAGE_SOURCE_UNAVAILABLE","IMAGE_SOURCE_URL_INVALID","IMAGE_STORAGE_QUOTA_EXCEEDED","IMAGE_URL_INVALID","IMAGE_URL_MUST_BE_CANONICAL","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_EXPECTED_VERSION","INVALID_IMAGE_ALT","INVALID_IMAGE_EXTERNAL_REFERENCE_ID","INVALID_IMAGE_GALLERY","INVALID_REQUEST","NORMALIZED_IMAGE_TOO_LARGE","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","VARIANT_IN_ACTIVE_BUNDLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.products.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.products.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/promotions":{"get":{"description":"Returns a paginated list of promotions for the authenticated merchant.","operationId":"listPromotions","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by promotion status. Repeat the parameter or pass comma-separated values to match multiple statuses.","explode":true,"in":"query","name":"status","required":false,"schema":{"items":{"enum":["active","inactive","expired","not_yet_started","exhausted","no_active_codes","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Expired.","Not yet started.","Exhausted.","No active codes.","Archived."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search across promotion ID, external reference ID, name, display name, description, and promotion codes.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Filter to promotions with an explicit product target rule. Universal promotions are not included by catalog target filters.","in":"query","name":"product_id","required":false,"schema":{"type":"string"}},{"description":"Filter to promotions with an explicit variant target rule. Universal promotions are not included by catalog target filters.","in":"query","name":"variant_id","required":false,"schema":{"type":"string"}},{"description":"Filter to promotions with an explicit bundle target rule. Universal promotions are not included by catalog target filters.","in":"query","name":"bundle_id","required":false,"schema":{"type":"string"}},{"description":"Filter to promotions with an explicit category target rule. Universal promotions are not included by catalog target filters.","in":"query","name":"category_handle","required":false,"schema":{"type":"string"}},{"description":"Filter by promotion redemption type.","in":"query","name":"redemption_type","required":false,"schema":{"enum":["automatic","code"],"type":"string","x-enum-descriptions":["Automatic.","Code."],"x-flint-enum":"closed"}},{"description":"Filter by promotion discount class.","in":"query","name":"discount_class","required":false,"schema":{"enum":["order","line_item","service_charge"],"type":"string","x-enum-descriptions":["Order.","Line item.","Service charge."],"x-flint-enum":"closed"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["name","created_at","updated_at"],"type":"string","x-enum-descriptions":["Name.","Created at.","Updated at."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"RFC3339 lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 lower bound for updated_at.","in":"query","name":"updated_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for updated_at.","in":"query","name":"updated_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"application_method":{"allocation":"across","calculation_basis":"subtotal_pre_tax","discounted_item_rules":[{"attribute":"line_item.categories","operator":"eq","values":["tickets"]}],"percent_off":20,"type":"percent_off"},"codes_summary":{"active_count":2,"newest_active_code":"SPRING20","total_count":3},"combines_with":{"line_item":false,"order":true,"service_charge":true},"created_at":"2026-03-17T14:30:00Z","discount_class":"line_item","display_name":"20% off spring tickets","max_uses":500,"merchant_id":"mer_123","metadata":{"campaign":"spring_launch"},"name":"Spring ticket launch Q2","promotion_id":"promo_01HZYV7Q9Y0Y4H8Q3H9F6R7T8J","redemption_type":"code","schedule":{"ends_at":"2026-04-01T00:00:00Z"},"stacking_mode":"continue","status":"active","updated_at":"2026-03-17T14:30:00Z","uses_count":24}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PromotionListResponse"}}},"description":"A page of promotions.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List promotions","tags":["promotions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.promotions.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.promotions.read","commerce.promotions.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates a promotion for the authenticated merchant.","operationId":"createPromotion","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"application_method":{"allocation":"across","calculation_basis":"subtotal_pre_tax","discounted_item_rules":[{"attribute":"line_item.categories","operator":"eq","values":["tickets"]}],"percent_off":20,"type":"percent_off"},"codes":[{"code":"SPRING20","max_uses":500}],"combines_with":{"line_item":false,"order":true,"service_charge":true},"discount_class":"line_item","display_name":"20% off spring tickets","max_uses":500,"metadata":{"campaign":"spring_launch"},"name":"Spring ticket launch Q2","redemption_type":"code","schedule":{"ends_at":"2026-04-01T00:00:00Z"},"stacking_mode":"continue"},"schema":{"allOf":[{"$ref":"#/components/schemas/CreatePromotionRequest"}],"properties":{"application_method":{"allOf":[{"$ref":"#/components/schemas/PromotionApplicationMethod"}],"oneOf":[{"properties":{"type":{"enum":["percent_off"],"type":"string","x-enum-descriptions":["Percent off."],"x-flint-enum":"closed"}},"required":["percent_off"],"type":"object"},{"properties":{"type":{"enum":["amount_off"],"type":"string","x-enum-descriptions":["Amount off."],"x-flint-enum":"closed"}},"required":["amount_off_money"],"type":"object"},{"properties":{"type":{"enum":["buy_x_get_y"],"type":"string","x-enum-descriptions":["Buy x get y."],"x-flint-enum":"closed"}},"required":["qualifying_item_rules","buy_min_quantity","discounted_item_rules","get_quantity","get_percent_off"],"type":"object"}]}}}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"application_method":{"allocation":"across","calculation_basis":"subtotal_pre_tax","discounted_item_rules":[{"attribute":"line_item.categories","operator":"eq","values":["tickets"]}],"percent_off":20,"type":"percent_off"},"codes_summary":{"active_count":2,"newest_active_code":"SPRING20","total_count":3},"combines_with":{"line_item":false,"order":true,"service_charge":true},"created_at":"2026-03-17T14:30:00Z","discount_class":"line_item","display_name":"20% off spring tickets","max_uses":500,"merchant_id":"mer_123","metadata":{"campaign":"spring_launch"},"name":"Spring ticket launch Q2","promotion_id":"promo_01HZYV7Q9Y0Y4H8Q3H9F6R7T8J","redemption_type":"code","schedule":{"ends_at":"2026-04-01T00:00:00Z"},"stacking_mode":"continue","status":"active","updated_at":"2026-03-17T14:30:00Z","uses_count":24},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PromotionResponse"}}},"description":"The created promotion.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create promotion","tags":["promotions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.promotions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.promotions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/promotions/by-code/{code}":{"get":{"description":"Resolves a buyer-entered promotion code to its promotion code record and parent promotion. This does not evaluate the code against an order or redeem it.","operationId":"resolvePromotionCode","parameters":[{"description":"Promotion code entered by the buyer.","in":"path","name":"code","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"promotion":{"application_method":{"allocation":"across","calculation_basis":"subtotal_pre_tax","discounted_item_rules":[{"attribute":"line_item.categories","operator":"eq","values":["tickets"]}],"percent_off":20,"type":"percent_off"},"codes_summary":{"active_count":2,"newest_active_code":"SPRING20","total_count":3},"combines_with":{"line_item":false,"order":true,"service_charge":true},"created_at":"2026-03-17T14:30:00Z","discount_class":"line_item","display_name":"20% off spring tickets","max_uses":500,"merchant_id":"mer_123","metadata":{"campaign":"spring_launch"},"name":"Spring ticket launch Q2","promotion_id":"promo_01HZYV7Q9Y0Y4H8Q3H9F6R7T8J","redemption_type":"code","schedule":{"ends_at":"2026-04-01T00:00:00Z"},"stacking_mode":"continue","status":"active","updated_at":"2026-03-17T14:30:00Z","uses_count":24},"promotion_code":{"code":"SPRING20","created_at":"2026-03-17T14:30:00Z","expires_at":"2026-04-01T00:00:00Z","max_uses":500,"merchant_id":"mer_123","metadata":{"campaign":"spring_launch"},"promotion_code_id":"pcode_01HZYV7Q9Y0Y4H8Q3H9F6R7T8J","promotion_id":"promo_01HZYV7Q9Y0Y4H8Q3H9F6R7T8J","status":"active","updated_at":"2026-03-17T14:30:00Z","uses_count":24}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PromotionCodeResolutionResponse"}}},"description":"The resolved promotion and promotion code.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"promotion not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Promotion code not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Resolve promotion code","tags":["promotions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.promotions.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.promotions.read","commerce.promotions.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/promotions/{promotion_id}":{"delete":{"description":"Archives a promotion and returns its final state.","operationId":"deletePromotion","parameters":[{"description":"Flint promotion ID.","in":"path","name":"promotion_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"application_method":{"allocation":"across","calculation_basis":"subtotal_pre_tax","discounted_item_rules":[{"attribute":"line_item.categories","operator":"eq","values":["tickets"]}],"percent_off":20,"type":"percent_off"},"codes_summary":{"active_count":2,"newest_active_code":"SPRING20","total_count":3},"combines_with":{"line_item":false,"order":true,"service_charge":true},"created_at":"2026-03-17T14:30:00Z","discount_class":"line_item","display_name":"20% off spring tickets","max_uses":500,"merchant_id":"mer_123","metadata":{"campaign":"spring_launch"},"name":"Spring ticket launch Q2","promotion_id":"promo_01HZYV7Q9Y0Y4H8Q3H9F6R7T8J","redemption_type":"code","schedule":{"ends_at":"2026-04-01T00:00:00Z"},"stacking_mode":"continue","status":"active","updated_at":"2026-03-17T14:30:00Z","uses_count":24},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PromotionResponse"}}},"description":"The archived promotion.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"promotion not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Promotion not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Delete promotion","tags":["promotions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.promotions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.promotions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Returns a single promotion by ID.","operationId":"getPromotion","parameters":[{"description":"Flint promotion ID.","in":"path","name":"promotion_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"application_method":{"allocation":"across","calculation_basis":"subtotal_pre_tax","discounted_item_rules":[{"attribute":"line_item.categories","operator":"eq","values":["tickets"]}],"percent_off":20,"type":"percent_off"},"codes_summary":{"active_count":2,"newest_active_code":"SPRING20","total_count":3},"combines_with":{"line_item":false,"order":true,"service_charge":true},"created_at":"2026-03-17T14:30:00Z","discount_class":"line_item","display_name":"20% off spring tickets","max_uses":500,"merchant_id":"mer_123","metadata":{"campaign":"spring_launch"},"name":"Spring ticket launch Q2","promotion_id":"promo_01HZYV7Q9Y0Y4H8Q3H9F6R7T8J","redemption_type":"code","schedule":{"ends_at":"2026-04-01T00:00:00Z"},"stacking_mode":"continue","status":"active","updated_at":"2026-03-17T14:30:00Z","uses_count":24},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PromotionResponse"}}},"description":"The requested promotion.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"promotion not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Promotion not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get promotion","tags":["promotions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.promotions.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.promotions.read","commerce.promotions.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Applies a sparse update to promotion fields.","operationId":"updatePromotion","parameters":[{"description":"Flint promotion ID.","in":"path","name":"promotion_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"description":"20% off selected spring tickets","status":"inactive"},"schema":{"allOf":[{"$ref":"#/components/schemas/UpdatePromotionRequest"}],"properties":{"application_method":{"allOf":[{"$ref":"#/components/schemas/PromotionApplicationMethod"}],"oneOf":[{"properties":{"type":{"enum":["percent_off"],"type":"string","x-enum-descriptions":["Percent off."],"x-flint-enum":"closed"}},"required":["percent_off"],"type":"object"},{"properties":{"type":{"enum":["amount_off"],"type":"string","x-enum-descriptions":["Amount off."],"x-flint-enum":"closed"}},"required":["amount_off_money"],"type":"object"},{"properties":{"type":{"enum":["buy_x_get_y"],"type":"string","x-enum-descriptions":["Buy x get y."],"x-flint-enum":"closed"}},"required":["qualifying_item_rules","buy_min_quantity","discounted_item_rules","get_quantity","get_percent_off"],"type":"object"}]}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"application_method":{"allocation":"across","calculation_basis":"subtotal_pre_tax","discounted_item_rules":[{"attribute":"line_item.categories","operator":"eq","values":["tickets"]}],"percent_off":20,"type":"percent_off"},"codes_summary":{"active_count":2,"newest_active_code":"SPRING20","total_count":3},"combines_with":{"line_item":false,"order":true,"service_charge":true},"created_at":"2026-03-17T14:30:00Z","discount_class":"line_item","display_name":"20% off spring tickets","max_uses":500,"merchant_id":"mer_123","metadata":{"campaign":"spring_launch"},"name":"Spring ticket launch Q2","promotion_id":"promo_01HZYV7Q9Y0Y4H8Q3H9F6R7T8J","redemption_type":"code","schedule":{"ends_at":"2026-04-01T00:00:00Z"},"stacking_mode":"continue","status":"active","updated_at":"2026-03-17T14:30:00Z","uses_count":24},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PromotionResponse"}}},"description":"The updated promotion.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"promotion not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Promotion not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update promotion","tags":["promotions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.promotions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.promotions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/promotions/{promotion_id}/codes":{"get":{"description":"Returns a paginated list of codes for a promotion.","operationId":"listPromotionCodes","parameters":[{"description":"Flint promotion ID.","in":"path","name":"promotion_id","required":true,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"code":"SPRING20","created_at":"2026-03-17T14:30:00Z","expires_at":"2026-04-01T00:00:00Z","max_uses":500,"merchant_id":"mer_123","metadata":{"campaign":"spring_launch"},"promotion_code_id":"pcode_01HZYV7Q9Y0Y4H8Q3H9F6R7T8J","promotion_id":"promo_01HZYV7Q9Y0Y4H8Q3H9F6R7T8J","status":"active","updated_at":"2026-03-17T14:30:00Z","uses_count":24}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PromotionCodeListResponse"}}},"description":"A page of promotion codes.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"promotion not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Promotion not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List promotion codes","tags":["promotions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.promotions.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.promotions.read","commerce.promotions.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates a code for a code-gated promotion.","operationId":"createPromotionCode","parameters":[{"description":"Flint promotion ID.","in":"path","name":"promotion_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"code":"VIP20","expires_at":"2026-04-01T00:00:00Z","max_uses":100,"metadata":{"audience":"vip"}},"schema":{"$ref":"#/components/schemas/CreatePromotionCodeRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"code":"SPRING20","created_at":"2026-03-17T14:30:00Z","expires_at":"2026-04-01T00:00:00Z","max_uses":500,"merchant_id":"mer_123","metadata":{"campaign":"spring_launch"},"promotion_code_id":"pcode_01HZYV7Q9Y0Y4H8Q3H9F6R7T8J","promotion_id":"promo_01HZYV7Q9Y0Y4H8Q3H9F6R7T8J","status":"active","updated_at":"2026-03-17T14:30:00Z","uses_count":24},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PromotionCodeResponse"}}},"description":"The created promotion code.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"promotion not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Promotion not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create promotion code","tags":["promotions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.promotions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.promotions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/promotions/{promotion_id}/codes/{promotion_code_id}":{"delete":{"description":"Deletes a promotion code.","operationId":"deletePromotionCode","parameters":[{"description":"Flint promotion ID.","in":"path","name":"promotion_id","required":true,"schema":{"type":"string"}},{"description":"Flint promotion code ID.","in":"path","name":"promotion_code_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"code":"SPRING20","created_at":"2026-03-17T14:30:00Z","expires_at":"2026-04-01T00:00:00Z","max_uses":500,"merchant_id":"mer_123","metadata":{"campaign":"spring_launch"},"promotion_code_id":"pcode_01HZYV7Q9Y0Y4H8Q3H9F6R7T8J","promotion_id":"promo_01HZYV7Q9Y0Y4H8Q3H9F6R7T8J","status":"active","updated_at":"2026-03-17T14:30:00Z","uses_count":24},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PromotionCodeResponse"}}},"description":"The deleted promotion code.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"promotion not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Promotion code not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Delete promotion code","tags":["promotions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.promotions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.promotions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"patch":{"description":"Applies a sparse update to a promotion code.","operationId":"updatePromotionCode","parameters":[{"description":"Flint promotion ID.","in":"path","name":"promotion_id","required":true,"schema":{"type":"string"}},{"description":"Flint promotion code ID.","in":"path","name":"promotion_code_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"max_uses":50,"status":"inactive"},"schema":{"$ref":"#/components/schemas/UpdatePromotionCodeRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"code":"SPRING20","created_at":"2026-03-17T14:30:00Z","expires_at":"2026-04-01T00:00:00Z","max_uses":500,"merchant_id":"mer_123","metadata":{"campaign":"spring_launch"},"promotion_code_id":"pcode_01HZYV7Q9Y0Y4H8Q3H9F6R7T8J","promotion_id":"promo_01HZYV7Q9Y0Y4H8Q3H9F6R7T8J","status":"active","updated_at":"2026-03-17T14:30:00Z","uses_count":24},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/PromotionCodeResponse"}}},"description":"The updated promotion code.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"promotion not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Promotion code not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update promotion code","tags":["promotions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.promotions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.promotions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/refunds":{"get":{"description":"Returns a paginated list of refunds for the authenticated merchant.","operationId":"listRefunds","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by order ID.","in":"query","name":"order_id","required":false,"schema":{"type":"string"}},{"description":"Filter by payment intent ID.","in":"query","name":"payment_intent_id","required":false,"schema":{"type":"string"}},{"description":"Filter by customer ID.","in":"query","name":"customer_id","required":false,"schema":{"type":"string"}},{"description":"Filter by refund status.","in":"query","name":"status","required":false,"schema":{"enum":["pending","in_transit","succeeded","failed","requires_action","canceled","partially_succeeded"],"type":"string","x-enum-descriptions":["Pending.","In transit.","Succeeded.","Failed.","Requires action.","Canceled.","Partially succeeded."],"x-flint-enum":"open"}},{"description":"Repeat the parameter to filter by multiple refund reasons.","explode":true,"in":"query","name":"reason","required":false,"schema":{"items":{"enum":["duplicate","fraudulent","requested_by_customer","defective_product","wrong_item_shipped","never_received","not_as_described","arrived_too_late","customer_changed_mind","better_price_found","accidental_order","other"],"type":"string","x-enum-descriptions":["Duplicate.","Fraudulent.","Requested by customer.","Defective product.","Wrong item shipped.","Never received.","Not as described.","Arrived too late.","Customer changed mind.","Better price found.","Accidental order.","Other."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Filter by refund method.","in":"query","name":"refund_method","required":false,"schema":{"enum":["original_payment"],"type":"string","x-enum-descriptions":["Original payment."],"x-flint-enum":"closed"}},{"description":"Inclusive lower bound in minor units. Requires currency.","in":"query","name":"min_amount","required":false,"schema":{"example":500,"format":"int64","minimum":1,"type":"integer"}},{"description":"Inclusive upper bound in minor units. Requires currency.","in":"query","name":"max_amount","required":false,"schema":{"example":500,"format":"int64","minimum":1,"type":"integer"}},{"description":"ISO 4217 currency for min_amount and max_amount.","in":"query","name":"currency","required":false,"schema":{"description":"ISO 4217 currency code.","example":"USD","maxLength":3,"minLength":3,"pattern":"^[A-Z]{3}$","type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Filter by linked Return ID.","in":"query","name":"return_id","required":false,"schema":{"type":"string"}},{"description":"Filter by linked ReturnResolution ID.","in":"query","name":"return_resolution_id","required":false,"schema":{"type":"string"}},{"description":"Search across refund_id, external_reference_id, and reason_message.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["created_at","updated_at","amount"],"type":"string","x-enum-descriptions":["Created at.","Updated at.","Amount."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"RFC3339 lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 lower bound for updated_at.","in":"query","name":"updated_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for updated_at.","in":"query","name":"updated_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"amount_money":{"amount":1000,"currency":"USD"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","metadata":{"ticket_id":"tkt_123"},"order_id":"ord_123","payment_intent_id":"pi_123","payment_refunds":[{"amount_money":{"amount":1000,"currency":"USD"},"payment_intent_id":"pi_123","refunded_tip_money":{"amount":100,"currency":"USD"},"status":"succeeded"}],"reason":"requested_by_customer","refund_id":"ref_123","refund_method":"original_payment","refunded_tip_money":{"amount":100,"currency":"USD"},"status":"succeeded","updated_at":"2026-03-17T14:30:00Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/RefundListResponse"}}},"description":"A page of refunds.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List refunds","tags":["refunds"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.refunds.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.refunds.read","commerce.refunds.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates a refund for an order or payment intent. This is a financial operation.","operationId":"createRefund","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"amount_money":{"amount":1000,"currency":"USD"},"metadata":{"ticket_id":"tkt_123"},"order_id":"ord_123","reason":"requested_by_customer"},"schema":{"$ref":"#/components/schemas/CreateRefundRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"amount_money":{"amount":1000,"currency":"USD"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","metadata":{"ticket_id":"tkt_123"},"order_id":"ord_123","payment_intent_id":"pi_123","payment_refunds":[{"amount_money":{"amount":1000,"currency":"USD"},"payment_intent_id":"pi_123","refunded_tip_money":{"amount":100,"currency":"USD"},"status":"succeeded"}],"reason":"requested_by_customer","refund_id":"ref_123","refund_method":"original_payment","refunded_tip_money":{"amount":100,"currency":"USD"},"status":"succeeded","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/RefundResponse"}}},"description":"The created refund.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create refund","tags":["refunds"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.refunds.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.refunds.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/refunds/{refund_id}":{"get":{"description":"Returns a single refund by ID.","operationId":"getRefund","parameters":[{"description":"Flint refund ID.","in":"path","name":"refund_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: customer, order, payment_intent, payment_refunds.payment_intent. Expansion requires commerce.refunds.read plus the read scope for each expanded resource. Limits: at most 10 unique expand paths per request; path depth at most 2. To-many expansions are capped at 20 related objects per path. Repeat expand, for example expand=customer\u0026expand=order, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["customer","order","payment_intent","payment_refunds.payment_intent"],"type":"string","x-enum-descriptions":["Customer.","Order.","Payment intent.","Payment refunds.payment intent."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Refund","value":{"data":{"amount_money":{"amount":1000,"currency":"USD"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","metadata":{"ticket_id":"tkt_123"},"order_id":"ord_123","payment_intent_id":"pi_123","payment_refunds":[{"amount_money":{"amount":1000,"currency":"USD"},"payment_intent_id":"pi_123","refunded_tip_money":{"amount":100,"currency":"USD"},"status":"succeeded"}],"reason":"requested_by_customer","refund_id":"ref_123","refund_method":"original_payment","refunded_tip_money":{"amount":100,"currency":"USD"},"status":"succeeded","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Refund with expanded relationships","value":{"data":{"amount_money":{"amount":1000,"currency":"USD"},"created_at":"2026-03-17T14:30:00Z","customer":{"created_at":"2026-03-16T12:00:00Z","customer_id":"cus_123","email":"buyer@example.com","name":"Avery Buyer","updated_at":"2026-03-17T14:00:00Z"},"customer_id":"cus_123","merchant_id":"mer_123","metadata":{"ticket_id":"tkt_123"},"order":{"created_at":"2026-03-17T14:20:00Z","customer_id":"cus_123","fulfillment_status":"not_fulfilled","order_id":"ord_123","order_number":"1001","payment_status":"","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","updated_at":"2026-03-17T14:30:00Z"},"order_id":"ord_123","payment_intent":{"amount_money":{"amount":5000,"currency":"USD"},"capture_method":"automatic","created_at":"2026-03-17T14:20:00Z","customer_id":"cus_123","order_id":"ord_123","payment_intent_id":"pi_123","payment_source":{"card":{"brand":"visa","last4":"4242"},"type":"card"},"refund_status":"none","status":"succeeded","updated_at":"2026-03-17T14:30:00Z"},"payment_intent_id":"pi_123","payment_refunds":[{"amount_money":{"amount":1000,"currency":"USD"},"payment_intent":{"amount_money":{"amount":5000,"currency":"USD"},"capture_method":"automatic","created_at":"2026-03-17T14:20:00Z","customer_id":"cus_123","order_id":"ord_123","payment_intent_id":"pi_123","payment_source":{"card":{"brand":"visa","last4":"4242"},"type":"card"},"refund_status":"none","status":"succeeded","updated_at":"2026-03-17T14:30:00Z"},"payment_intent_id":"pi_123","refunded_tip_money":{"amount":100,"currency":"USD"},"status":"succeeded"}],"reason":"requested_by_customer","refund_id":"ref_123","refund_method":"original_payment","refunded_tip_money":{"amount":100,"currency":"USD"},"status":"succeeded","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/RefundResponse"}}},"description":"The requested refund.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"examples":{"invalid_expand":{"summary":"Unsupported expand path","value":{"error":{"code":"INVALID_EXPAND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Unknown expand path \"card\" for GET /v1/refunds/{refund_id}. Supported values: customer, order, payment_intent, payment_refunds.payment_intent.","param":"expand","remediation":{"next_steps":"Fix or remove the requested expand path; use only supported values documented for the route.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}},"validation":{"summary":"Validation error","value":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"refund not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Refund not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get refund","tags":["refunds"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_EXPAND","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.refunds.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.refunds.read","commerce.refunds.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Updates refund metadata.","operationId":"updateRefund","parameters":[{"description":"Flint refund ID.","in":"path","name":"refund_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"metadata":{"reviewed_by":"ops"}},"schema":{"$ref":"#/components/schemas/UpdateRefundRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"amount_money":{"amount":1000,"currency":"USD"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","metadata":{"ticket_id":"tkt_123"},"order_id":"ord_123","payment_intent_id":"pi_123","payment_refunds":[{"amount_money":{"amount":1000,"currency":"USD"},"payment_intent_id":"pi_123","refunded_tip_money":{"amount":100,"currency":"USD"},"status":"succeeded"}],"reason":"requested_by_customer","refund_id":"ref_123","refund_method":"original_payment","refunded_tip_money":{"amount":100,"currency":"USD"},"status":"succeeded","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/RefundResponse"}}},"description":"The updated refund.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"refund not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Refund not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update refund","tags":["refunds"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.refunds.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.refunds.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/report-downloads/{report_download_id}":{"get":{"description":"Authorizes the stable Flint download URL and redirects to a short-lived private file URL.","operationId":"getReportDownload","parameters":[{"description":"Flint report download ID.","in":"path","name":"report_download_id","required":true,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"307":{"description":"Temporary redirect to the generated CSV.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Location":{"description":"Short-lived private file URL.","schema":{"format":"uri","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Report download not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"410":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Report download expired.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Reporting is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Download a report","tags":["reports"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","RATE_LIMIT_EXCEEDED","REPORTING_UNAVAILABLE","REPORT_DOWNLOAD_EXPIRED","REPORT_NOT_FOUND","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["reports.read","reports.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/reports":{"get":{"description":"Lists reports in descending creation order using opaque pagination.","operationId":"listReports","parameters":[{"description":"Number of reports to return.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque token returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportListResponse"}}},"description":"Reports for the authenticated merchant.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Reporting is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List reports","tags":["reports"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_PAGE_SIZE","INVALID_PAGE_TOKEN","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REPORTING_UNAVAILABLE","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["reports.read","reports.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates an idempotent asynchronous CSV report. Poll the returned report until it succeeds or fails.","operationId":"createReport","parameters":[{"description":"Optional idempotency key for safe retries. Flint generates and returns one when omitted.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReportRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportResponse"}}},"description":"The pending or idempotently replayed report.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Idempotency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Reporting is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create a report","tags":["reports"],"x-flint-error-codes":["AUTH_REQUIRED","IDEMPOTENCY_KEY_REUSED","IDEMPOTENCY_KEY_TOO_LONG","INSUFFICIENT_SCOPE","INVALID_CURRENCY","INVALID_IDEMPOTENCY_KEY","INVALID_INTERVAL_END_AT","INVALID_INTERVAL_START_AT","INVALID_REPORT_INTERVAL","INVALID_REPORT_TYPE","INVALID_REQUEST","INVALID_REQUEST_BODY","INVALID_TIMEZONE","RATE_LIMIT_EXCEEDED","REPORTING_UNAVAILABLE","REPORT_INTERVAL_INCOMPLETE","REPORT_INTERVAL_TOO_LARGE","SERVICE_UNAVAILABLE","TOO_MANY_PENDING_REPORTS"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["reports.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/reports/{report_id}":{"get":{"description":"Returns one report and its terminal download or failure details when available.","operationId":"getReport","parameters":[{"description":"Flint report ID.","in":"path","name":"report_id","required":true,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportResponse"}}},"description":"The requested report.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Reporting is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get a report","tags":["reports"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REPORTING_UNAVAILABLE","REPORT_NOT_FOUND","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["reports.read","reports.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/return-dispositions":{"get":{"description":"List merchandise dispositions. Omitting return_id lists dispositions across every Return for the merchant.","operationId":"listReturnDispositions","parameters":[{"description":"RFC3339 created after filter.","in":"query","name":"created_after","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"RFC3339 created before filter.","in":"query","name":"created_before","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Filter by disposition type.","in":"query","name":"disposition_type","required":false,"schema":{"enum":["sellable","quality_control","damaged","quarantined","repair","refurbish","liquidate","donate","discard","return_to_buyer","lost"],"type":"string","x-enum-descriptions":["Sellable.","Quality control.","Damaged.","Quarantined.","Repair.","Refurbish.","Liquidate.","Donate.","Discard.","Return to buyer.","Lost."],"x-flint-enum":"closed"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Filter by inventory location id.","in":"query","name":"inventory_location_id","required":false,"schema":{"type":"string"}},{"description":"RFC3339 occurred after filter.","in":"query","name":"occurred_after","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"RFC3339 occurred before filter.","in":"query","name":"occurred_before","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Page size. Defaults to 20 and is capped at 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Search by return disposition ID or external reference ID.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Filter by replaces return disposition id.","in":"query","name":"replaces_return_disposition_id","required":false,"schema":{"type":"string"}},{"description":"Filter by return id.","in":"query","name":"return_id","required":false,"schema":{"type":"string"}},{"description":"Filter by return inspection line item id.","in":"query","name":"return_inspection_line_item_id","required":false,"schema":{"type":"string"}},{"description":"Filter by return line item id.","in":"query","name":"return_line_item_id","required":false,"schema":{"type":"string"}},{"description":"Filter by return receipt line item id.","in":"query","name":"return_receipt_line_item_id","required":false,"schema":{"type":"string"}},{"description":"Filter by status.","in":"query","name":"status","required":false,"schema":{"enum":["pending","succeeded","failed","canceled"],"type":"string","x-enum-descriptions":["Pending.","Succeeded.","Failed.","Canceled."],"x-flint-enum":"open"}},{"description":"RFC3339 updated after filter.","in":"query","name":"updated_after","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"RFC3339 updated before filter.","in":"query","name":"updated_before","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListReturnDispositionsResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List return dispositions","tags":["return_operations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/return-dispositions/{return_disposition_id}":{"get":{"description":"Retrieve one disposition with its type, destination, quantity, status, and any linked inventory effect.","operationId":"getReturnDisposition","parameters":[{"description":"Flint return disposition id.","in":"path","name":"return_disposition_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReturnDispositionResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get return disposition","tags":["return_operations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/return-dispositions/{return_disposition_id}/cancel":{"post":{"description":"Cancel a disposition that has not started its inventory effect. Cancellation is refused once the effect is processing.","operationId":"cancelReturnDisposition","parameters":[{"description":"Flint return disposition id.","in":"path","name":"return_disposition_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelReturnDispositionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelReturnDispositionResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Cancel return disposition","tags":["return_operations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.operations.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.operations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/return-dispositions/{return_disposition_id}/retry":{"post":{"description":"Retry a failed disposition with the same immutable intent. Disposition and effect identities are preserved, so a retry does not move stock twice.","operationId":"retryReturnDisposition","parameters":[{"description":"Flint return disposition id.","in":"path","name":"return_disposition_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryReturnDispositionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryReturnDispositionResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Retry return disposition","tags":["return_operations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.operations.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.operations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/return-inspections":{"get":{"description":"List inspection observations. Omitting return_id lists inspections across every Return for the merchant.","operationId":"listReturnInspections","parameters":[{"description":"Filter by acceptance status.","in":"query","name":"acceptance_status","required":false,"schema":{"enum":["accepted","rejected","review_required"],"type":"string","x-enum-descriptions":["Accepted.","Rejected.","Review required."],"x-flint-enum":"open"}},{"description":"RFC3339 created after filter.","in":"query","name":"created_after","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"RFC3339 created before filter.","in":"query","name":"created_before","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"RFC3339 inspected after filter.","in":"query","name":"inspected_after","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"RFC3339 inspected before filter.","in":"query","name":"inspected_before","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Filter by location id.","in":"query","name":"location_id","required":false,"schema":{"type":"string"}},{"description":"Page size. Defaults to 20 and is capped at 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Search by return inspection ID or external reference ID.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Filter by return id.","in":"query","name":"return_id","required":false,"schema":{"type":"string"}},{"description":"Filter by return line item id.","in":"query","name":"return_line_item_id","required":false,"schema":{"type":"string"}},{"description":"Filter by return receipt id.","in":"query","name":"return_receipt_id","required":false,"schema":{"type":"string"}},{"description":"Filter by source system type.","in":"query","name":"source_system_type","required":false,"schema":{"enum":["manual","pos","wms","erp","other","flint"],"type":"string","x-enum-descriptions":["Manual.","Pos.","Wms.","Erp.","Other.","Flint."],"x-flint-enum":"closed"}},{"description":"Filter by status.","in":"query","name":"status","required":false,"schema":{"enum":["current","superseded"],"type":"string","x-enum-descriptions":["Current.","Superseded."],"x-flint-enum":"open"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListReturnInspectionsResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List return inspections","tags":["return_operations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/return-inspections/{return_inspection_id}":{"get":{"description":"Retrieve one inspection with its line items, findings, and current or superseded observation status.","operationId":"getReturnInspection","parameters":[{"description":"Flint return inspection id.","in":"path","name":"return_inspection_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReturnInspectionResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get return inspection","tags":["return_operations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/return-inspections/{return_inspection_id}/line-items/{return_inspection_line_item_id}/decide":{"post":{"description":"Record the accept or reject outcome for inspected quantity. Accepted quantity becomes dispositionable and satisfies after_inspection refund timing.","operationId":"decideReturnInspectionLineItem","parameters":[{"description":"Flint return inspection id.","in":"path","name":"return_inspection_id","required":true,"schema":{"type":"string"}},{"description":"Flint return inspection line item id.","in":"path","name":"return_inspection_line_item_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecideReturnInspectionLineItemRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecideReturnInspectionLineItemResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Decide return inspection line item","tags":["return_operations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.operations.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.operations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/return-policies":{"get":{"description":"List Return policies with their status and current revision.","operationId":"listReturnPolicies","parameters":[{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Page size. Defaults to 20 and is capped at 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Search by return policy ID, name, or external reference ID.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Filter by status.","explode":false,"in":"query","name":"status","required":false,"schema":{"items":{"enum":["active","inactive","archived"],"type":"string","x-enum-descriptions":["Active.","Inactive.","Archived."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListReturnPoliciesResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List return policies","tags":["return_policies"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Create a Return policy with its first revision. The policy ID is stable across revisions, and each published revision is immutable.","operationId":"createReturnPolicy","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnPolicyRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnPolicyResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create return policy","tags":["return_policies"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.return_policies.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/return-policies/{return_policy_id}":{"delete":{"description":"Retire a Return policy so it is no longer evaluated and no longer appears as an active choice.","operationId":"deleteReturnPolicy","parameters":[{"description":"Flint return policy id.","in":"path","name":"return_policy_id","required":true,"schema":{"type":"string"}},{"description":"Filter by expected version.","in":"query","name":"expected_version","required":false,"schema":{"format":"int64","minimum":1,"type":"integer"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReturnPolicyResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Retire return policy","tags":["return_policies"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.return_policies.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Retrieve one Return policy. Supports expand for current_revision.","operationId":"getReturnPolicy","parameters":[{"description":"Flint return policy id.","in":"path","name":"return_policy_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: current_revision. Expanded relationships are returned only when explicitly requested and authorized. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=current_revision\u0026expand=current_revision, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["current_revision"],"type":"string","x-enum-descriptions":["Current revision."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Resource without expanded relationships","value":{"data":{"current_return_policy_revision_id":"rpolv_01K1VERSION0000000000","name":"Standard returns","return_policy_id":"rpol_01K1POLICY000000000000","status":"active"},"request_id":"req_123"}},"expanded":{"summary":"Resource with expanded relationships","value":{"data":{"current_return_policy_revision_id":"rpolv_01K1VERSION0000000000","current_revision":{"priority":100,"return_policy_id":"rpol_01K1POLICY000000000000","return_policy_revision_id":"rpolv_01K1VERSION0000000000"},"name":"Standard returns","return_policy_id":"rpol_01K1POLICY000000000000","status":"active"},"request_id":"req_123"}}},"schema":{"$ref":"#/components/schemas/GetReturnPolicyResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get return policy","tags":["return_policies"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Update policy identity fields or set status to active or inactive. Rules live on revisions, so changing a window, fee, or scope means publishing a new revision.","operationId":"updateReturnPolicy","parameters":[{"description":"Flint return policy id.","in":"path","name":"return_policy_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReturnPolicyRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReturnPolicyResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update return policy","tags":["return_policies"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.return_policies.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/return-policies/{return_policy_id}/revisions":{"get":{"description":"List every published revision of a Return policy.","operationId":"listReturnPolicyRevisions","parameters":[{"description":"Flint return policy id.","in":"path","name":"return_policy_id","required":true,"schema":{"type":"string"}},{"description":"Page size. Defaults to 20 and is capped at 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListReturnPolicyRevisionsResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List return policy revisions","tags":["return_policies"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Publish a new immutable Return policy revision while preserving the stable policy identity.","operationId":"publishReturnPolicyRevision","parameters":[{"description":"Flint return policy id.","in":"path","name":"return_policy_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishReturnPolicyRevisionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishReturnPolicyRevisionResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Publish return policy revision","tags":["return_policies"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.return_policies.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/return-policies/{return_policy_id}/revisions/{return_policy_revision_id}":{"get":{"description":"Retrieve one immutable policy revision, including the exact rules a Return was evaluated against.","operationId":"getReturnPolicyRevision","parameters":[{"description":"Flint return policy id.","in":"path","name":"return_policy_id","required":true,"schema":{"type":"string"}},{"description":"Flint return policy revision id.","in":"path","name":"return_policy_revision_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReturnPolicyRevisionResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get return policy revision","tags":["return_policies"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/return-previews":{"post":{"description":"Preview return eligibility or resolution amounts without creating a Return or reserving quantity. Set mode to eligibility or resolution and send the matching input object.","operationId":"createReturnPreview","parameters":[{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnPreviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnPreviewResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create return preview","tags":["returns"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/return-reasons":{"get":{"description":"List Return reasons, including Flint-provided defaults and merchant-defined reasons.","operationId":"listReturnReasons","parameters":[{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Page size. Defaults to 20 and is capped at 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Search by return reason ID, handle, name, description, or external reference ID.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Filter by source.","in":"query","name":"source","required":false,"schema":{"enum":["flint","merchant"],"type":"string","x-enum-descriptions":["Flint.","Merchant."],"x-flint-enum":"closed"}},{"description":"Filter by status.","explode":false,"in":"query","name":"status","required":false,"schema":{"items":{"enum":["active","archived"],"type":"string","x-enum-descriptions":["Active.","Archived."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListReturnReasonsResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List return reasons","tags":["return_reasons"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Create a merchant Return reason buyers can select. Buyer reasons are distinct from inspection findings, decline reasons, and Refund reasons.","operationId":"createReturnReason","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnReasonRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnReasonResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create return reason","tags":["return_reasons"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.return_reasons.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_reasons.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/return-reasons/{return_reason_id}":{"delete":{"description":"Retire a Return reason so buyers can no longer select it. Returns that already recorded it keep the frozen reason name.","operationId":"deleteReturnReason","parameters":[{"description":"Flint return reason id.","in":"path","name":"return_reason_id","required":true,"schema":{"type":"string"}},{"description":"Filter by expected version.","in":"query","name":"expected_version","required":false,"schema":{"format":"int64","minimum":1,"type":"integer"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReturnReasonResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Retire return reason","tags":["return_reasons"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.return_reasons.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_reasons.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Retrieve one Return reason with its handle, category handles, and status.","operationId":"getReturnReason","parameters":[{"description":"Flint return reason id.","in":"path","name":"return_reason_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReturnReasonResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get return reason","tags":["return_reasons"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Update a Return reason. Send null to clear description. A present category_handles array replaces the existing set.","operationId":"updateReturnReason","parameters":[{"description":"Flint return reason id.","in":"path","name":"return_reason_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReturnReasonRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReturnReasonResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update return reason","tags":["return_reasons"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.return_reasons.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_reasons.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/return-receipts":{"get":{"description":"List merchandise receipts. Omitting return_id lists receipts across every Return for the merchant.","operationId":"listReturnReceipts","parameters":[{"description":"RFC3339 created after filter.","in":"query","name":"created_after","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"RFC3339 created before filter.","in":"query","name":"created_before","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Page size. Defaults to 20 and is capped at 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Search by return receipt ID or external reference ID.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"RFC3339 received after filter.","in":"query","name":"received_after","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"RFC3339 received before filter.","in":"query","name":"received_before","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Filter by receiving location id.","in":"query","name":"receiving_location_id","required":false,"schema":{"type":"string"}},{"description":"Filter by return id.","in":"query","name":"return_id","required":false,"schema":{"type":"string"}},{"description":"Filter by return line item id.","in":"query","name":"return_line_item_id","required":false,"schema":{"type":"string"}},{"description":"Filter by shipment id.","in":"query","name":"shipment_id","required":false,"schema":{"type":"string"}},{"description":"Filter by source system type.","in":"query","name":"source_system_type","required":false,"schema":{"enum":["manual","pos","wms","erp","other","flint"],"type":"string","x-enum-descriptions":["Manual.","Pos.","Wms.","Erp.","Other.","Flint."],"x-flint-enum":"closed"}},{"description":"Filter by status.","in":"query","name":"status","required":false,"schema":{"enum":["current","superseded"],"type":"string","x-enum-descriptions":["Current.","Superseded."],"x-flint-enum":"open"}},{"description":"Filter by verification status.","in":"query","name":"verification_status","required":false,"schema":{"enum":["matched","unverified","excess"],"type":"string","x-enum-descriptions":["Matched.","Unverified.","Excess."],"x-flint-enum":"open"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListReturnReceiptsResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List return receipts","tags":["return_operations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/return-receipts/{return_receipt_id}":{"get":{"description":"Retrieve one merchandise receipt with its line items and its current or superseded observation status.","operationId":"getReturnReceipt","parameters":[{"description":"Flint return receipt id.","in":"path","name":"return_receipt_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReturnReceiptResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get return receipt","tags":["return_operations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/return-receipts/{return_receipt_id}/line-items/{return_receipt_line_item_id}/verify":{"post":{"description":"Establish the Return line identity for receipt quantity that arrived without one. Unverified quantity counts toward no line and releases no refund timing gate until it is verified.","operationId":"verifyReturnReceiptLineItem","parameters":[{"description":"Flint return receipt id.","in":"path","name":"return_receipt_id","required":true,"schema":{"type":"string"}},{"description":"Flint return receipt line item id.","in":"path","name":"return_receipt_line_item_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyReturnReceiptLineItemRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyReturnReceiptLineItemResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Verify return receipt line item","tags":["return_operations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.operations.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.operations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/return-resolutions":{"get":{"description":"List resolutions. Filter by corrects_return_resolution_id to retrieve the correction history for a resolution that already settled.","operationId":"listReturnResolutions","parameters":[{"description":"Filter by action required by.","in":"query","name":"action_required_by","required":false,"schema":{"enum":["buyer","merchant","integration"],"type":"string","x-enum-descriptions":["Buyer.","Merchant.","Integration."],"x-flint-enum":"closed"}},{"description":"Filter by corrects return resolution id.","in":"query","name":"corrects_return_resolution_id","required":false,"schema":{"type":"string"}},{"description":"RFC3339 created after filter.","in":"query","name":"created_after","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"RFC3339 created before filter.","in":"query","name":"created_before","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Page size. Defaults to 20 and is capped at 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Search by return resolution ID or external reference ID.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Filter by resolution type.","explode":false,"in":"query","name":"resolution_type","required":false,"schema":{"items":{"enum":["refund","exchange","replacement","no_monetary_action","correction"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action.","Correction."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Filter by return id.","in":"query","name":"return_id","required":false,"schema":{"type":"string"}},{"description":"Filter by return line item id.","in":"query","name":"return_line_item_id","required":false,"schema":{"type":"string"}},{"description":"Filter by return policy revision id.","in":"query","name":"return_policy_revision_id","required":false,"schema":{"type":"string"}},{"description":"Filter by status.","explode":false,"in":"query","name":"status","required":false,"schema":{"items":{"enum":["proposed","pending","requires_action","partially_fulfilled","fulfilled","failed","canceled"],"type":"string","x-enum-descriptions":["Proposed.","Pending.","Requires action.","Partially fulfilled.","Fulfilled.","Failed.","Canceled."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"RFC3339 updated after filter.","in":"query","name":"updated_after","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"RFC3339 updated before filter.","in":"query","name":"updated_before","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListReturnResolutionsResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List return resolutions","tags":["return_resolutions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/return-resolutions/{return_resolution_id}":{"get":{"description":"Retrieve one resolution with its amounts, adjustments, execution blockers, and linked refunds, payments, and replacement order. Supports expand for those links.","operationId":"getReturnResolution","parameters":[{"description":"Flint return resolution id.","in":"path","name":"return_resolution_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: payment_intents, refunds, replacement_order. Expanded relationships are returned only when explicitly requested and authorized. Limits: at most 10 unique expand paths per request; path depth at most 2. To-many expansions are capped at 20 related objects per path. Repeat expand, for example expand=payment_intents\u0026expand=refunds, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["payment_intents","refunds","replacement_order"],"type":"string","x-enum-descriptions":["Payment intents.","Refunds.","Replacement order."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Resource without expanded relationships","value":{"data":{"payment_intent_ids":["pi_01K1PAYMENT00000000000000"],"refund_ids":["ref_01K1REFUND00000000000000"],"replacement_order_id":"ord_01K1REPLACEMENT000000000","return_id":"ret_01K1RETURN000000000000000","return_resolution_id":"retres_01K1RESOLUTION000000000"},"request_id":"req_123"}},"expanded":{"summary":"Resource with expanded relationships","value":{"data":{"payment_intent_ids":["pi_01K1PAYMENT00000000000000"],"payment_intents":[{"payment_intent_id":"pi_01K1PAYMENT00000000000000","status":"succeeded"}],"refund_ids":["ref_01K1REFUND00000000000000"],"refunds":[{"refund_id":"ref_01K1REFUND00000000000000","status":"succeeded"}],"replacement_order":{"order_id":"ord_01K1REPLACEMENT000000000","status":"open"},"replacement_order_id":"ord_01K1REPLACEMENT000000000","return_id":"ret_01K1RETURN000000000000000","return_resolution_id":"retres_01K1RESOLUTION000000000"},"request_id":"req_123"}}},"schema":{"$ref":"#/components/schemas/GetReturnResolutionResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get return resolution","tags":["return_resolutions"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Update a proposed resolution before confirmation. A present line_items or replacement_line_items array replaces that collection and requires expected_version.","operationId":"updateReturnResolution","parameters":[{"description":"Flint return resolution id.","in":"path","name":"return_resolution_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReturnResolutionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReturnResolutionResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update return resolution","tags":["return_resolutions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.resolutions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.resolutions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/return-resolutions/{return_resolution_id}/cancel":{"post":{"description":"Cancel a resolution and release the line value it reserved. Effects that already succeeded are undone with a compensating correction instead.","operationId":"cancelReturnResolution","parameters":[{"description":"Flint return resolution id.","in":"path","name":"return_resolution_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelReturnResolutionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelReturnResolutionResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Cancel return resolution","tags":["return_resolutions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.resolutions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.resolutions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/return-resolutions/{return_resolution_id}/checkout-session":{"post":{"description":"Create or reuse the standard hosted checkout session for a buyer-owed replacement Order linked to this Return resolution.","operationId":"getOrCreateReturnResolutionCheckoutSession","parameters":[{"description":"Flint return resolution id.","in":"path","name":"return_resolution_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateReturnResolutionCheckoutSessionResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get or create return resolution checkout session","tags":["return_resolutions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.resolutions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.resolutions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/return-resolutions/{return_resolution_id}/confirm":{"post":{"description":"Confirm a proposed resolution and freeze its economic facts. Execution can remain pending behind line-qualified execution blockers.","operationId":"confirmReturnResolution","parameters":[{"description":"Flint return resolution id.","in":"path","name":"return_resolution_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmReturnResolutionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmReturnResolutionResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Confirm return resolution","tags":["return_resolutions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.resolutions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.resolutions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/return-resolutions/{return_resolution_id}/release":{"post":{"description":"Release a confirmed resolution that is waiting on a manual release. Available only while action_reason is manual_release.","operationId":"releaseReturnResolution","parameters":[{"description":"Flint return resolution id.","in":"path","name":"return_resolution_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseReturnResolutionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseReturnResolutionResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Release return resolution","tags":["return_resolutions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.resolutions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.resolutions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/return-resolutions/{return_resolution_id}/retry":{"post":{"description":"Retry a failed resolution. A new attempt starts, historical payment and refund IDs stay on the resolution, and a late event from an earlier attempt cannot settle the new attempt.","operationId":"retryReturnResolution","parameters":[{"description":"Flint return resolution id.","in":"path","name":"return_resolution_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryReturnResolutionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryReturnResolutionResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Retry return resolution","tags":["return_resolutions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.resolutions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.resolutions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/returns":{"get":{"description":"List Returns for the merchant, filtered by order, customer, status, decision, merchandise, resolution, or creation window. Filter by idempotency_key to recover a create whose response never arrived.","operationId":"listReturns","parameters":[{"description":"RFC3339 created after filter.","in":"query","name":"created_after","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"RFC3339 created before filter.","in":"query","name":"created_before","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Filter by customer id.","in":"query","name":"customer_id","required":false,"schema":{"type":"string"}},{"description":"Filter by decision status.","explode":false,"in":"query","name":"decision_status","required":false,"schema":{"items":{"enum":["pending","approved","partially_approved","declined"],"type":"string","x-enum-descriptions":["Pending.","Approved.","Partially approved.","Declined."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Filter by merchandise status.","explode":false,"in":"query","name":"merchandise_status","required":false,"schema":{"items":{"enum":["not_required","awaiting_handoff","in_transit","partially_received","received","inspection_required","partially_inspected","inspection_review_required","disposition_required","resolved","exception"],"type":"string","x-enum-descriptions":["Not required.","Awaiting handoff.","In transit.","Partially received.","Received.","Inspection required.","Partially inspected.","Inspection review required.","Disposition required.","Resolved.","Exception."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"Filter by order id.","in":"query","name":"order_id","required":false,"schema":{"type":"string"}},{"description":"Page size. Defaults to 20 and is capped at 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Search by return ID, return number, external reference ID, the order's number, or the buyer's email.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Filter by receiving location id.","in":"query","name":"receiving_location_id","required":false,"schema":{"type":"string"}},{"description":"Filter by resolution status.","explode":false,"in":"query","name":"resolution_status","required":false,"schema":{"items":{"enum":["not_selected","pending","partially_fulfilled","requires_action","fulfilled","failed"],"type":"string","x-enum-descriptions":["Not selected.","Pending.","Partially fulfilled.","Requires action.","Fulfilled.","Failed."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"Filter by resolution type.","explode":false,"in":"query","name":"resolution_type","required":false,"schema":{"items":{"enum":["refund","exchange","replacement","no_monetary_action","correction"],"type":"string","x-enum-descriptions":["Refund.","Exchange.","Replacement.","No monetary action.","Correction."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Filter by return number.","in":"query","name":"return_number","required":false,"schema":{"type":"string"}},{"description":"Filter by return reason id.","in":"query","name":"return_reason_id","required":false,"schema":{"type":"string"}},{"description":"Filter by status.","explode":false,"in":"query","name":"status","required":false,"schema":{"items":{"enum":["requested","open","completed","declined","canceled"],"type":"string","x-enum-descriptions":["Requested.","Open.","Completed.","Declined.","Canceled."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"RFC3339 updated after filter.","in":"query","name":"updated_after","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"RFC3339 updated before filter.","in":"query","name":"updated_before","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Filter by work type. Matches only returns that are still requested or open.","explode":false,"in":"query","name":"work_type","required":false,"schema":{"items":{"enum":["decision","handoff","receipt","inspection","disposition","resolution","exception"],"type":"string","x-enum-descriptions":["Decision.","Handoff.","Receipt.","Inspection.","Disposition.","Resolution.","Exception."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListReturnsResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List returns","tags":["returns"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Create a requested Return. When no policy matches, the Return remains available for merchant review rather than failing creation.","operationId":"createReturn","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create return","tags":["returns"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/returns/{return_id}":{"get":{"description":"Retrieve a Return with its line items, policy evaluation, financial summary, and completion blockers. Supports expand for the order, the customer, and each line item's reason and fulfillment.","operationId":"getReturn","parameters":[{"description":"Flint return id.","in":"path","name":"return_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: customer, line_items.fulfillment, line_items.return_reason, order. Expanded relationships are returned only when explicitly requested and authorized. Limits: at most 10 unique expand paths per request; path depth at most 2. To-many expansions are capped at 20 related objects per path. Repeat expand, for example expand=customer\u0026expand=line_items.fulfillment, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["customer","line_items.fulfillment","line_items.return_reason","order"],"type":"string","x-enum-descriptions":["Customer.","Line items.fulfillment.","Line items.return reason.","Order."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Resource without expanded relationships","value":{"data":{"customer_id":"cus_01K1CUSTOMER00000000000","line_items":[{"fulfillment_id":"ful_01K1FULFILLMENT000000000","return_line_item_id":"retli_01K1LINE000000000000000","return_reason_id":"rrsn_01K1REASON000000000000"}],"order_id":"ord_01K1ORDER000000000000000","return_id":"ret_01K1RETURN000000000000000"},"request_id":"req_123"}},"expanded":{"summary":"Resource with expanded relationships","value":{"data":{"customer":{"customer_id":"cus_01K1CUSTOMER00000000000","email":"buyer@example.com"},"customer_id":"cus_01K1CUSTOMER00000000000","line_items":[{"fulfillment":{"fulfillment_id":"ful_01K1FULFILLMENT000000000","order_id":"ord_01K1ORDER000000000000000","status":"completed","type":"shipment"},"fulfillment_id":"ful_01K1FULFILLMENT000000000","return_line_item_id":"retli_01K1LINE000000000000000","return_reason":{"handle":"changed_mind","name":"Changed mind","return_reason_id":"rrsn_01K1REASON000000000000","source":"flint","status":"active"},"return_reason_id":"rrsn_01K1REASON000000000000"}],"order":{"order_id":"ord_01K1ORDER000000000000000","status":"open"},"order_id":"ord_01K1ORDER000000000000000","return_id":"ret_01K1RETURN000000000000000"},"request_id":"req_123"}}},"schema":{"$ref":"#/components/schemas/GetReturnResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get return","tags":["returns"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Update caller-owned fields on a Return. Only external_reference_id and metadata are writable; every other change goes through a decision, operation, or resolution command.","operationId":"updateReturn","parameters":[{"description":"Flint return id.","in":"path","name":"return_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReturnRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReturnResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update return","tags":["returns"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/returns/{return_id}/cancel":{"post":{"description":"Cancel a Return before any merchandise or value work commits. Cancellation is refused once a receipt, inspection, disposition, or resolution exists.","operationId":"cancelReturn","parameters":[{"description":"Flint return id.","in":"path","name":"return_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelReturnRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelReturnResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Cancel return","tags":["returns"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/returns/{return_id}/complete":{"post":{"description":"Complete a Return whose completion_mode is manual. The call fails while completion_blockers is non-empty. Automatic Returns complete themselves when the final blocker clears.","operationId":"completeReturn","parameters":[{"description":"Flint return id.","in":"path","name":"return_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompleteReturnRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompleteReturnResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Complete return","tags":["returns"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/returns/{return_id}/decide":{"post":{"description":"Record per-line Return decisions atomically. Each line selects policy_evaluation or explicit decision semantics.","operationId":"decideReturn","parameters":[{"description":"Flint return id.","in":"path","name":"return_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecideReturnRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecideReturnResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Decide return","tags":["returns"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.decisions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.decisions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/returns/{return_id}/dispositions":{"post":{"description":"Record an auditable merchandise disposition from either a receipt line or an inspection line.","operationId":"createReturnDisposition","parameters":[{"description":"Flint return id.","in":"path","name":"return_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnDispositionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnDispositionResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create return disposition","tags":["return_operations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.operations.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.operations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/returns/{return_id}/inspections":{"post":{"description":"Record an immutable inspection observation. Corrections supersede an earlier inspection instead of editing physical history.","operationId":"createReturnInspection","parameters":[{"description":"Flint return id.","in":"path","name":"return_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnInspectionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnInspectionResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create return inspection","tags":["return_operations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.operations.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.operations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/returns/{return_id}/line-items":{"get":{"description":"List the line items on a Return with their quantity counters, eligibility, frozen display identity, and return value.","operationId":"listReturnLineItems","parameters":[{"description":"Flint return id.","in":"path","name":"return_id","required":true,"schema":{"type":"string"}},{"description":"Filter by fulfillment id.","in":"query","name":"fulfillment_id","required":false,"schema":{"type":"string"}},{"description":"Filter by merchandise status.","explode":false,"in":"query","name":"merchandise_status","required":false,"schema":{"items":{"enum":["not_required","awaiting_handoff","in_transit","partially_received","received","inspection_required","partially_inspected","inspection_review_required","disposition_required","resolved","exception"],"type":"string","x-enum-descriptions":["Not required.","Awaiting handoff.","In transit.","Partially received.","Received.","Inspection required.","Partially inspected.","Inspection review required.","Disposition required.","Resolved.","Exception."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"Filter by order line item id.","in":"query","name":"order_line_item_id","required":false,"schema":{"type":"string"}},{"description":"Page size. Defaults to 20 and is capped at 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"format":"int32","maximum":100,"minimum":1,"type":"integer"}},{"description":"Opaque cursor returned by the previous page.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by resolution status.","explode":false,"in":"query","name":"resolution_status","required":false,"schema":{"items":{"enum":["not_selected","pending","partially_fulfilled","requires_action","fulfilled","failed"],"type":"string","x-enum-descriptions":["Not selected.","Pending.","Partially fulfilled.","Requires action.","Fulfilled.","Failed."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"Filter by return reason id.","in":"query","name":"return_reason_id","required":false,"schema":{"type":"string"}},{"description":"Filter by status.","explode":false,"in":"query","name":"status","required":false,"schema":{"items":{"enum":["requested","open","completed","declined","canceled"],"type":"string","x-enum-descriptions":["Requested.","Open.","Completed.","Declined.","Canceled."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListReturnLineItemsResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List return line items","tags":["returns"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Add a line item to a requested Return. The response is the updated Return, not the new line.","operationId":"addReturnLineItem","parameters":[{"description":"Flint return id.","in":"path","name":"return_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddReturnLineItemRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddReturnLineItemResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Add return line item","tags":["returns"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/returns/{return_id}/line-items/{return_line_item_id}":{"delete":{"description":"Remove a line item from a requested Return. The response is the updated Return.","operationId":"deleteReturnLineItem","parameters":[{"description":"Flint return id.","in":"path","name":"return_id","required":true,"schema":{"type":"string"}},{"description":"Flint return line item id.","in":"path","name":"return_line_item_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteReturnLineItemResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Delete return line item","tags":["returns"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Retrieve one Return line item, including its quantity counters and the reason the buyer selected.","operationId":"getReturnLineItem","parameters":[{"description":"Flint return id.","in":"path","name":"return_id","required":true,"schema":{"type":"string"}},{"description":"Flint return line item id.","in":"path","name":"return_line_item_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReturnLineItemResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get return line item","tags":["returns"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Update a requested Return line item. Send null to clear buyer_note or requested_resolution_type. The response is the updated Return.","operationId":"updateReturnLineItem","parameters":[{"description":"Flint return id.","in":"path","name":"return_id","required":true,"schema":{"type":"string"}},{"description":"Flint return line item id.","in":"path","name":"return_line_item_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReturnLineItemRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReturnLineItemResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update return line item","tags":["returns"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/returns/{return_id}/line-items/{return_line_item_id}/cancel":{"post":{"description":"Cancel approved quantity on a Return line item. Quantity already received, inspected, dispositioned, or reserved by a resolution cannot be canceled, and the conflict response names what is blocking it.","operationId":"cancelReturnLineItem","parameters":[{"description":"Flint return id.","in":"path","name":"return_id","required":true,"schema":{"type":"string"}},{"description":"Flint return line item id.","in":"path","name":"return_line_item_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelReturnLineItemRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelReturnLineItemResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Cancel return line item","tags":["returns"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.decisions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.decisions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/returns/{return_id}/line-items/{return_line_item_id}/waive-inspection":{"post":{"description":"Waive the inspection requirement on a Return line item so received quantity can be dispositioned and resolved without an inspection observation.","operationId":"waiveReturnLineInspection","parameters":[{"description":"Flint return id.","in":"path","name":"return_id","required":true,"schema":{"type":"string"}},{"description":"Flint return line item id.","in":"path","name":"return_line_item_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WaiveReturnLineInspectionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WaiveReturnLineInspectionResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Waive return line inspection","tags":["returns"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.decisions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.decisions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/returns/{return_id}/process":{"post":{"description":"Process an existing requested Return atomically at the Flint facts layer. Requires the current Return version and Idempotency-Key. Linked effects remain asynchronous.","operationId":"processExistingReturn","parameters":[{"description":"Flint return id.","in":"path","name":"return_id","required":true,"schema":{"type":"string"}},{"description":"Required durable command identity. Exact replay returns the original resource graph.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessExistingReturnRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessExistingReturnResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Process existing return","tags":["returns"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.process.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.process.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/returns/{return_id}/receipts":{"post":{"description":"Record an immutable merchandise receipt observation. Corrections supersede an earlier receipt instead of editing physical history.","operationId":"createReturnReceipt","parameters":[{"description":"Flint return id.","in":"path","name":"return_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnReceiptRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnReceiptResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create return receipt","tags":["return_operations"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.operations.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.operations.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/returns/{return_id}/reopen":{"post":{"description":"Reopen a completed Return to record late compensating facts. Confirmed money movements are never edited backward, so a monetary fix is a new correction resolution.","operationId":"reopenReturn","parameters":[{"description":"Flint return id.","in":"path","name":"return_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReopenReturnRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReopenReturnResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Reopen return","tags":["returns"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.decisions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.decisions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/returns/{return_id}/resolutions":{"post":{"description":"Propose a buyer-value outcome for approved quantity. Creating a resolution reserves line value. Confirmation is what freezes it and starts its effects.","operationId":"createReturnResolution","parameters":[{"description":"Flint return id.","in":"path","name":"return_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnResolutionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReturnResolutionResponse"}}},"description":"Successful response.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"State or version conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create return resolution","tags":["return_resolutions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.returns.resolutions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.returns.resolutions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/reviews":{"get":{"description":"List payment reviews for the authenticated merchant environment.","operationId":"listReviews","parameters":[{"description":"Filter by review status. Repeat or comma-separate values.","explode":true,"in":"query","name":"status","required":false,"schema":{"items":{"enum":["open","resolving","closed"],"type":"string","x-enum-descriptions":["Open.","Resolving.","Closed."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"Filter by immutable review risk level. Repeat or comma-separate values.","explode":true,"in":"query","name":"risk_level","required":false,"schema":{"items":{"enum":["normal","elevated","highest","not_assessed"],"type":"string","x-enum-descriptions":["Normal.","Elevated.","Highest.","Not assessed."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Filter by immutable payment flow. Repeat or comma-separate values.","explode":true,"in":"query","name":"payment_flow","required":false,"schema":{"items":{"enum":["checkout","payment_link","invoice","subscription_initial","subscription_renewal","virtual_terminal","api"],"type":"string","x-enum-descriptions":["Checkout.","Payment link.","Invoice.","Subscription initial.","Subscription renewal.","Virtual terminal.","Api."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Filter by Flint payment intent ID.","in":"query","name":"payment_intent_id","required":false,"schema":{"type":"string"}},{"description":"Filter by Flint order ID.","in":"query","name":"order_id","required":false,"schema":{"type":"string"}},{"description":"Filter by Flint customer ID.","in":"query","name":"customer_id","required":false,"schema":{"type":"string"}},{"description":"Filter reviews opened after this RFC3339 timestamp.","in":"query","name":"created_after","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewListResponse"}}},"description":"List payment reviews result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List payment reviews","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.controls.write","risk.read","risk.reviews.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/reviews/{review_id}":{"get":{"description":"Get a payment review for the authenticated merchant environment.","operationId":"getReview","parameters":[{"description":"Flint review ID.","in":"path","name":"review_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: customer, order, payment_intent. Expansion requires risk.read plus the read scope for each expanded resource. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=customer\u0026expand=order, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["customer","order","payment_intent"],"type":"string","x-enum-descriptions":["Customer.","Order.","Payment intent."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Review","value":{"data":{"closed_at":null,"closed_by":null,"closed_reason":null,"customer_id":"cus_123","ip_address":null,"ip_address_location":null,"matched_risk_rule_id":null,"opened_at":"2026-07-09T18:02:11Z","opened_reason":"rule","order_id":"ord_123","payment_flow":"checkout","payment_intent_id":"pi_123","payment_summary":{"amount_money":{"amount":12900,"currency":"USD"},"authorization_expires_at":null,"capture_method":"automatic","email":"buyer@example.com","last4":"4242","payment_method_brand":"visa"},"pending_action":null,"refund_id":null,"refunded_amount_money":null,"resolution_started_at":null,"resolution_started_by":null,"review_id":"rev_123","risk":{"level":"elevated","score":null},"status":"open"},"request_id":"req_123"}},"expanded":{"summary":"Review with expanded relationships","value":{"data":{"closed_at":null,"closed_by":null,"closed_reason":null,"customer":{"customer_id":"cus_123","email":"buyer@example.com"},"customer_id":"cus_123","ip_address":null,"ip_address_location":null,"matched_risk_rule_id":null,"opened_at":"2026-07-09T18:02:11Z","opened_reason":"rule","order":{"order_id":"ord_123","payment_status":"","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":0,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":0,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":0,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":0,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open"},"order_id":"ord_123","payment_flow":"checkout","payment_intent":{"amount_money":{"amount":12900,"currency":"USD"},"payment_intent_id":"pi_123","status":"succeeded"},"payment_intent_id":"pi_123","payment_summary":{"amount_money":{"amount":12900,"currency":"USD"},"authorization_expires_at":null,"capture_method":"automatic","email":"buyer@example.com","last4":"4242","payment_method_brand":"visa"},"pending_action":null,"refund_id":null,"refunded_amount_money":null,"resolution_started_at":null,"resolution_started_by":null,"review_id":"rev_123","risk":{"level":"elevated","score":null},"status":"open"},"request_id":"req_123"}}},"schema":{"$ref":"#/components/schemas/ReviewResponse"}}},"description":"The requested payment review.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get a payment review","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.controls.write","risk.read","risk.reviews.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/reviews/{review_id}/approve":{"post":{"description":"Approve a payment review for the authenticated merchant environment.","operationId":"approveReview","parameters":[{"description":"Flint review ID.","in":"path","name":"review_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewResponse"}}},"description":"Approve a payment review result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk control conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Approve a payment review","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.reviews.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.reviews.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"external_provider_action"}},"/v1/reviews/{review_id}/decline":{"post":{"description":"Decline a payment review for the authenticated merchant environment.","operationId":"declineReview","parameters":[{"description":"Flint review ID.","in":"path","name":"review_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeclineReviewRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewResponse"}}},"description":"Decline a payment review result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewResponse"}}},"description":"Review resolution accepted and still in progress.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"Retry-After":{"description":"Seconds to wait before polling the review resource again.","schema":{"minimum":1,"type":"integer"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk control conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Decline a payment review","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.reviews.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.reviews.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"external_provider_action"}},"/v1/risk-lists":{"get":{"description":"List risk lists for the authenticated merchant environment.","operationId":"listRiskLists","parameters":[{"description":"Include archived resources.","in":"query","name":"include_archived","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskListListResponse"}}},"description":"List risk lists result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List risk lists","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_BOOLEAN","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.controls.write","risk.read","risk.reviews.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Create a risk list for the authenticated merchant environment.","operationId":"createRiskList","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRiskListRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskListResourceResponse"}}},"description":"Create a risk list result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"examples":{"alias_already_exists":{"summary":"Risk list alias already exists","value":{"error":{"code":"RISK_LIST_ALIAS_ALREADY_EXISTS","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"A risk list with this alias already exists in this environment.","param":"alias","remediation":{"next_steps":"Inspect the error response, correct the request or resource state, then retry.","retryable":false},"request_id":"req_123","request_log_url":"/v1/developer/request-logs?request_id=req_123","type":"conflict_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A risk list with the requested alias already exists.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create a risk list","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","RISK_LIST_ALIAS_ALREADY_EXISTS","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.controls.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.controls.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"write"}},"/v1/risk-lists/{risk_list_id}":{"delete":{"description":"Retire a risk list for the authenticated merchant environment.","operationId":"deleteRiskList","parameters":[{"description":"Flint risk list ID.","in":"path","name":"risk_list_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskListResourceResponse"}}},"description":"Retire a risk list result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk control conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Retire a risk list","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.controls.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.controls.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"write"},"get":{"description":"Get a risk list for the authenticated merchant environment.","operationId":"getRiskList","parameters":[{"description":"Flint risk list ID.","in":"path","name":"risk_list_id","required":true,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskListResourceResponse"}}},"description":"Get a risk list result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get a risk list","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.controls.write","risk.read","risk.reviews.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Update a risk list for the authenticated merchant environment.","operationId":"updateRiskList","parameters":[{"description":"Flint risk list ID.","in":"path","name":"risk_list_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRiskListRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskListResourceResponse"}}},"description":"Update a risk list result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk control conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update a risk list","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.controls.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.controls.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"write"}},"/v1/risk-lists/{risk_list_id}/items":{"get":{"description":"List risk list items for the authenticated merchant environment.","operationId":"listRiskListItems","parameters":[{"description":"Flint risk list ID.","in":"path","name":"risk_list_id","required":true,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskListItemListResponse"}}},"description":"List risk list items result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List risk list items","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.controls.write","risk.read","risk.reviews.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Add risk list items for the authenticated merchant environment.","operationId":"addRiskListItems","parameters":[{"description":"Flint risk list ID.","in":"path","name":"risk_list_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddRiskListItemsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskListItemResultsResponse"}}},"description":"All requested risk list items already existed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskListItemResultsResponse"}}},"description":"Add risk list items result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk control conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Add risk list items","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.controls.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.controls.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"write"}},"/v1/risk-lists/{risk_list_id}/items/{risk_list_item_id}":{"delete":{"description":"Delete a risk list item for the authenticated merchant environment.","operationId":"deleteRiskListItem","parameters":[{"description":"Flint risk list ID.","in":"path","name":"risk_list_id","required":true,"schema":{"type":"string"}},{"description":"Flint risk list item ID.","in":"path","name":"risk_list_item_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskListItemResponse"}}},"description":"Delete a risk list item result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk control conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Delete a risk list item","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.controls.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.controls.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"write"},"get":{"description":"Get a risk list item for the authenticated merchant environment.","operationId":"getRiskListItem","parameters":[{"description":"Flint risk list ID.","in":"path","name":"risk_list_id","required":true,"schema":{"type":"string"}},{"description":"Flint risk list item ID.","in":"path","name":"risk_list_item_id","required":true,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskListItemResponse"}}},"description":"Get a risk list item result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get a risk list item","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.controls.write","risk.read","risk.reviews.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/risk-previews":{"post":{"description":"Create a risk preview for the authenticated merchant environment.","operationId":"createRiskPreview","parameters":[{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRiskPreviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskRuleValidationResponse"}}},"description":"Create a risk preview result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk control conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create a risk preview","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.controls.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.controls.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/risk-rules":{"get":{"description":"List risk rules for the authenticated merchant environment.","operationId":"listRiskRules","parameters":[{"description":"Include archived resources.","in":"query","name":"include_archived","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskRuleListResponse"}}},"description":"List risk rules result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List risk rules","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_BOOLEAN","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.controls.write","risk.read","risk.reviews.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Create a risk rule for the authenticated merchant environment.","operationId":"createRiskRule","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRiskRuleRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskRuleResponse"}}},"description":"Create a risk rule result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk control conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create a risk rule","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.controls.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.controls.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"write"}},"/v1/risk-rules/attributes":{"get":{"description":"Get the risk rule attribute registry for the authenticated merchant environment.","operationId":"getRiskRuleAttributeRegistry","parameters":[{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskRuleAttributeRegistryResponse"}}},"description":"Get the risk rule attribute registry result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get the risk rule attribute registry","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.controls.write","risk.read","risk.reviews.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/risk-rules/{risk_rule_id}":{"delete":{"description":"Retire a risk rule for the authenticated merchant environment.","operationId":"deleteRiskRule","parameters":[{"description":"Flint risk rule ID.","in":"path","name":"risk_rule_id","required":true,"schema":{"type":"string"}},{"description":"Optional risk rule version last read by the caller.","in":"query","name":"expected_version","required":false,"schema":{"format":"int64","minimum":1,"type":"integer"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskRuleResponse"}}},"description":"Retire a risk rule result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk control conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Retire a risk rule","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_EXPECTED_VERSION","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","RISK_CONTROL_CONFLICT","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.controls.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.controls.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"write"},"get":{"description":"Get a risk rule for the authenticated merchant environment.","operationId":"getRiskRule","parameters":[{"description":"Flint risk rule ID.","in":"path","name":"risk_rule_id","required":true,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskRuleResponse"}}},"description":"Get a risk rule result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get a risk rule","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.controls.write","risk.read","risk.reviews.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Update a risk rule for the authenticated merchant environment.","operationId":"updateRiskRule","parameters":[{"description":"Flint risk rule ID.","in":"path","name":"risk_rule_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRiskRuleRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskRuleResponse"}}},"description":"Update a risk rule result.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk control conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Risk controls are unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update a risk rule","tags":["risk"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_EXPECTED_VERSION","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","RISK_CONTROL_CONFLICT","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["risk.controls.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["risk.controls.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"write"}},"/v1/settings":{"get":{"description":"Returns the raw merchant-scoped settings record for the authenticated merchant. No inheritance is applied.","operationId":"getSettings","parameters":[{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"branding":{"accent_color":"#f59e0b","primary_color":"#0f766e"},"catalog":{"default_delivery_profile_id":"dprof_01J9K7M6N5P4Q3R2S1T0UVWXYZ","updated_at":"2026-03-17T14:30:00Z","version":4},"checkout":{"default_expires_in_seconds":3600,"enabled_payment_options":["card","apple_pay","google_pay"],"promotion_code_entry_enabled":true,"require_email":true},"created_at":"2026-03-17T14:30:00Z","inventory":{"low_stock_threshold":5,"origin_policies":{"default":{"post_payment_inventory_failure_action":"exception_state"},"subscription":{"subscription_inventory_block_action":"inventory_blocked_open_invoice"}}},"legal":{"require_terms_of_service":true,"terms_of_service_url":"https://example.com/terms"},"merchant_id":"mer_123","metadata":{"channel":"retail"},"payment_limits":{"max_amounts":{"default":{"amount":100000,"currency":"USD"},"payment_link":{"amount":250000,"currency":"USD"}},"min_amounts":{"default":{"amount":50,"currency":"USD"},"payment_link.donation":{"amount":100,"currency":"USD"}}},"promotions":{"automatic_enabled":true,"codes_enabled":true,"max_promotions_per_order":2},"receipts":{"header_text":"Thanks for your purchase","is_auto_email_enabled":true},"settings_id":"set_123","settings_scope":"merchant","subscriptions":{"dunning_end_action":"cancel","dunning_retry_days":16},"tax":{"default_enabled":true},"tax_identity":null,"tipping":{"default_enabled":true,"default_tip_percentage":18,"is_custom_tip_enabled":true,"tip_percentages":[15,18,20]},"updated_at":"2026-03-17T14:30:00Z","version":0},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SettingsResponse"}}},"description":"The merchant settings record.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Catalog settings are temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get merchant settings","tags":["settings"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_SERVICE_UNAVAILABLE","INSUFFICIENT_SCOPE","INVALID_API_KEY","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["settings.read","settings.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Applies a sparse patch to merchant-scoped settings. Send catalog by itself because it has its own version fence. Fee and payment limit controls remain internal-only.","operationId":"updateSettings","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"checkout":{"enabled_payment_options":["card","apple_pay","google_pay"],"promotion_code_entry_enabled":true,"require_email":true},"metadata":{"channel":"omnichannel"},"promotions":{"codes_enabled":true},"receipts":{"footer_text":"Come back soon"}},"schema":{"$ref":"#/components/schemas/UpdateSettingsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"branding":{"accent_color":"#f59e0b","primary_color":"#0f766e"},"catalog":{"default_delivery_profile_id":"dprof_01J9K7M6N5P4Q3R2S1T0UVWXYZ","updated_at":"2026-03-17T14:30:00Z","version":4},"checkout":{"default_expires_in_seconds":3600,"enabled_payment_options":["card","apple_pay","google_pay"],"promotion_code_entry_enabled":true,"require_email":true},"created_at":"2026-03-17T14:30:00Z","inventory":{"low_stock_threshold":5,"origin_policies":{"default":{"post_payment_inventory_failure_action":"exception_state"},"subscription":{"subscription_inventory_block_action":"inventory_blocked_open_invoice"}}},"legal":{"require_terms_of_service":true,"terms_of_service_url":"https://example.com/terms"},"merchant_id":"mer_123","metadata":{"channel":"retail"},"payment_limits":{"max_amounts":{"default":{"amount":100000,"currency":"USD"},"payment_link":{"amount":250000,"currency":"USD"}},"min_amounts":{"default":{"amount":50,"currency":"USD"},"payment_link.donation":{"amount":100,"currency":"USD"}}},"promotions":{"automatic_enabled":true,"codes_enabled":true,"max_promotions_per_order":2},"receipts":{"header_text":"Thanks for your purchase","is_auto_email_enabled":true},"settings_id":"set_123","settings_scope":"merchant","subscriptions":{"dunning_end_action":"cancel","dunning_retry_days":16},"tax":{"default_enabled":true},"tax_identity":null,"tipping":{"default_enabled":true,"default_tip_percentage":18,"is_custom_tip_enabled":true,"tip_percentages":[15,18,20]},"updated_at":"2026-03-17T14:30:00Z","version":0},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SettingsResponse"}}},"description":"The updated merchant settings record.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Delivery profile not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Catalog settings are temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update merchant settings","tags":["settings"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_REQUEST_INVALID","DELIVERY_RESOURCE_NOT_FOUND","DELIVERY_SERVICE_UNAVAILABLE","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","SETTINGS_CONCURRENT_MODIFICATION"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["settings.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/settings/effective":{"get":{"description":"Returns the fully resolved effective settings for the authenticated merchant. Optional device_id or location_id can be used to resolve inherited overrides.","operationId":"getEffectiveSettings","parameters":[{"description":"Optional Flint location ID to resolve effective settings for.","in":"query","name":"location_id","required":false,"schema":{"type":"string"}},{"description":"Optional Flint device ID to resolve effective settings for. When set, the device location takes precedence.","in":"query","name":"device_id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"branding":{"accent_color":"#f59e0b","primary_color":"#0f766e"},"catalog":{"default_delivery_profile_id":"dprof_01J9K7M6N5P4Q3R2S1T0UVWXYZ","updated_at":"2026-03-17T14:30:00Z","version":4},"checkout":{"default_expires_in_seconds":3600,"enabled_payment_options":["card","apple_pay","google_pay"],"promotion_code_entry_enabled":true,"require_email":true},"created_at":"2026-03-17T14:30:00Z","device_id":"dev_123","inventory":{"low_stock_threshold":5,"origin_policies":{"default":{"post_payment_inventory_failure_action":"exception_state"},"subscription":{"subscription_inventory_block_action":"inventory_blocked_open_invoice"}}},"legal":{"require_terms_of_service":true,"terms_of_service_url":"https://example.com/terms"},"location_id":"loc_123","merchant_id":"mer_123","metadata":{"channel":"retail"},"payment_limits":{"max_amounts":{"default":{"amount":100000,"currency":"USD"},"payment_link":{"amount":250000,"currency":"USD"}},"min_amounts":{"default":{"amount":50,"currency":"USD"},"payment_link.donation":{"amount":100,"currency":"USD"}}},"promotions":{"automatic_enabled":true,"codes_enabled":true,"max_promotions_per_order":2},"receipts":{"header_text":"Thanks for your purchase","is_auto_email_enabled":true},"settings_id":"set_123","settings_scope":"device","subscriptions":{"dunning_end_action":"cancel","dunning_retry_days":16},"tax":{"default_enabled":true},"tax_identity":null,"tipping":{"default_enabled":true,"default_tip_percentage":18,"is_custom_tip_enabled":true,"tip_percentages":[15,18,20]},"updated_at":"2026-03-17T14:30:00Z","version":0},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SettingsResponse"}}},"description":"The effective settings record.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"device not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Device not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Catalog settings are temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get effective settings","tags":["settings"],"x-flint-error-codes":["AUTH_REQUIRED","DELIVERY_SERVICE_UNAVAILABLE","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["settings.read","settings.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/shipments":{"get":{"description":"Lists shipment execution records, newest created first.","operationId":"listShipments","parameters":[{"description":"Optional order ID filter.","in":"query","name":"order_id","required":false,"schema":{"type":"string"}},{"description":"Optional fulfillment ID filter.","in":"query","name":"fulfillment_id","required":false,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by external system identifier.","in":"query","name":"external_system","required":false,"schema":{"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search across shipment ID, external reference ID, and tracking number.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Filter by linked Return ID.","in":"query","name":"return_id","required":false,"schema":{"type":"string"}},{"description":"RFC3339 lower bound for handed_off_at.","in":"query","name":"handed_off_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for handed_off_at.","in":"query","name":"handed_off_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"created_at":"2026-05-13T15:59:00Z","direction":"outbound","external_reference_id":"ship_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","handed_off_at":"2026-05-13T16:00:00Z","metadata":{"warehouse":"east"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_count":0,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","shipped_at":"2026-05-13T16:00:00Z","status":"created","updated_at":"2026-05-13T16:00:00Z","version":1}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ShipmentListResponse"}}},"description":"Shipments for the fulfillment.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List shipments","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.read","commerce.orders.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/shipments/{shipment_id}":{"get":{"description":"Retrieves one shipment execution record by ID.","operationId":"getShipment","parameters":[{"description":"Flint shipment ID.","in":"path","name":"shipment_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: order. Expansion requires commerce.orders.read. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=order\u0026expand=order, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["order"],"type":"string","x-enum-descriptions":["Order."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Shipment","value":{"data":{"created_at":"2026-05-13T15:59:00Z","direction":"outbound","external_reference_id":"ship_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","handed_off_at":"2026-05-13T16:00:00Z","metadata":{"warehouse":"east"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_count":0,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","shipped_at":"2026-05-13T16:00:00Z","status":"created","updated_at":"2026-05-13T16:00:00Z","version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Shipment with expanded order","value":{"data":{"created_at":"2026-05-13T15:59:00Z","direction":"outbound","external_reference_id":"ship_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","handed_off_at":"2026-05-13T16:00:00Z","metadata":{"warehouse":"east"},"order":{"created_at":"2026-05-13T09:30:00Z","customer_id":"cus_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_status":"completed","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","order_number":"1001","payment_intent_ids":["pi_01ABCDEFGHIJKLMNOPQRSTUVWX"],"payment_status":"","pricing_amounts":{"charge_money":{"amount":0,"currency":"USD"},"discount_money":{"amount":0,"currency":"USD"},"requested_tip_money":{"amount":0,"currency":"USD"},"subtotal_money":{"amount":5000,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"total_money":{"amount":5000,"currency":"USD"}},"refund_status":"none","settlement_amounts":{"balance_money":{"amount":5000,"currency":"USD"},"credit_money":{"amount":0,"currency":"USD"},"net_collected_money":{"amount":0,"currency":"USD"},"outstanding_money":{"amount":5000,"currency":"USD"},"paid_money":{"amount":0,"currency":"USD"},"refunded_money":{"amount":0,"currency":"USD"},"settled_tip_money":{"amount":0,"currency":"USD"}},"status":"open","updated_at":"2026-05-13T14:30:00Z"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_count":0,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","shipped_at":"2026-05-13T16:00:00Z","status":"created","updated_at":"2026-05-13T16:00:00Z","version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/ShipmentResponse"}}},"description":"The shipment.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order, fulfillment, or shipment not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get shipment","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.read","commerce.orders.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Updates shipment metadata and caller-owned external references. Shipment status is derived from package statuses and cannot be patched directly. expected_version is optional and rejects a stale resource version when supplied.","operationId":"updateShipment","parameters":[{"description":"Flint shipment ID.","in":"path","name":"shipment_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"expected_version":1,"metadata":{"route":"A7","warehouse":"east"}},"schema":{"$ref":"#/components/schemas/UpdateShipmentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"shipment":{"created_at":"2026-05-13T15:59:00Z","direction":"outbound","external_reference_id":"ship_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","handed_off_at":"2026-05-13T16:00:00Z","metadata":{"warehouse":"east"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_count":0,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","shipped_at":"2026-05-13T16:00:00Z","status":"created","updated_at":"2026-05-13T16:00:00Z","version":1}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/UpdateShipmentResponse"}}},"description":"The updated shipment.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order, fulfillment, or shipment not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"SHIPMENT_CHANGED","details":[{"code":"SHIPMENT_CHANGED","current_resource":{"created_at":"2026-05-13T15:59:00Z","direction":"outbound","external_reference_id":"ship_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","handed_off_at":"2026-05-13T16:00:00Z","metadata":{"warehouse":"east"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_count":0,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","shipped_at":"2026-05-13T16:00:00Z","status":"created","updated_at":"2026-05-13T16:00:00Z","version":1},"current_status":"created","current_version":1,"message":"the shipment changed","param":"expected_version","remediation":{"next_steps":"Read the current shipment and retry with its version as expected_version.","retryable":true}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"expected_version does not match the current shipment version; read the shipment and retry","param":"expected_version","remediation":{"next_steps":"Read the current shipment and retry with its version as expected_version.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The shipment version changed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update shipment","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_EXPECTED_VERSION","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SHIPMENT_CHANGED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/shipments/{shipment_id}/packages":{"post":{"description":"Creates a package record under a shipment. Package status transitions use explicit future status APIs; this endpoint records package-level carrier, tracking, label, measurement, and external correlation fields.","operationId":"createPackage","parameters":[{"description":"Flint shipment ID.","in":"path","name":"shipment_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"buyer_notification_behavior":"request","carrier":"ups","dimensions":{"height":4,"length":8,"unit":"in","width":6},"external_reference_id":"pkg_789","external_system":"merchant_wms","metadata":{"box":"small"},"service_code":"ground","tracking_number":"1Z999AA10123456784","tracking_url":"https://track.example.com/1Z999AA10123456784","weight":{"unit":"lb","value":1.2}},"schema":{"$ref":"#/components/schemas/CreatePackageRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"fulfillment_event":{"buyer_notification_behavior":"request","custom_details":{"current_carrier":"ups","current_service_code":"ground","current_tracking_number":"1Z999AA10123456784","current_tracking_url":"https://track.example.com/1Z999AA10123456784","resource_type":"package"},"event_type":"tracking_updated","fulfillment_event_id":"fev_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","message":"Package tracking updated","occurred_at":"2026-05-13T16:01:00Z","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","received_at":"2026-05-13T16:01:00Z","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","subject_type":""},"fulfillment_notifications":[{"channel":"email","created_at":"2026-05-13T16:01:00Z","fulfillment_event_id":"fev_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_notification_id":"fnt_01ABCDEFGHIJKLMNOPQRSTUVWX","notification_type":"tracking_updated","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","recipient_email":"buyer@example.com","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"pending","trigger_type":"fulfillment_event_created","updated_at":"2026-05-13T16:01:00Z"}],"package":{"carrier":"ups","created_at":"2026-05-13T16:01:00Z","dimensions":{"height":4,"length":8,"unit":"in","width":6},"external_reference_id":"pkg_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","metadata":{"box":"small"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","service_code":"ground","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"created","supported_actions":["mark_packed","mark_shipped","mark_in_transit","mark_out_for_delivery","mark_delivered","mark_delivery_attempted","mark_exception"],"tracking_number":"1Z999AA10123456784","tracking_url":"https://track.example.com/1Z999AA10123456784","updated_at":"2026-05-13T16:01:00Z","version":1,"weight":{"unit":"lb","value":1.2}},"replayed":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CreatePackageResponse"}}},"description":"The replayed package for an existing provider reference.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"201":{"content":{"application/json":{"example":{"data":{"fulfillment_event":{"buyer_notification_behavior":"request","custom_details":{"current_carrier":"ups","current_service_code":"ground","current_tracking_number":"1Z999AA10123456784","current_tracking_url":"https://track.example.com/1Z999AA10123456784","resource_type":"package"},"event_type":"tracking_updated","fulfillment_event_id":"fev_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","message":"Package tracking updated","occurred_at":"2026-05-13T16:01:00Z","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","received_at":"2026-05-13T16:01:00Z","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","subject_type":""},"fulfillment_notifications":[{"channel":"email","created_at":"2026-05-13T16:01:00Z","fulfillment_event_id":"fev_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","fulfillment_notification_id":"fnt_01ABCDEFGHIJKLMNOPQRSTUVWX","notification_type":"tracking_updated","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","recipient_email":"buyer@example.com","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"pending","trigger_type":"fulfillment_event_created","updated_at":"2026-05-13T16:01:00Z"}],"package":{"carrier":"ups","created_at":"2026-05-13T16:01:00Z","dimensions":{"height":4,"length":8,"unit":"in","width":6},"external_reference_id":"pkg_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","metadata":{"box":"small"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","service_code":"ground","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"created","supported_actions":["mark_packed","mark_shipped","mark_in_transit","mark_out_for_delivery","mark_delivered","mark_delivery_attempted","mark_exception"],"tracking_number":"1Z999AA10123456784","tracking_url":"https://track.example.com/1Z999AA10123456784","updated_at":"2026-05-13T16:01:00Z","version":1,"weight":{"unit":"lb","value":1.2}}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CreatePackageResponse"}}},"description":"The newly created package.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order, fulfillment, or shipment not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create package","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/shipments/{shipment_id}/void":{"post":{"description":"Voids a shipment before carrier handoff and voids all child packages that have not shipped. The action appends timeline events for the shipment and affected packages. expected_version is optional and rejects a stale resource version when supplied.","operationId":"voidShipment","parameters":[{"description":"Flint shipment ID.","in":"path","name":"shipment_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"buyer_notification_behavior":"suppress","expected_version":1,"occurred_at":"2026-05-13T16:08:00Z","reason":"Label canceled before carrier pickup."},"schema":{"$ref":"#/components/schemas/VoidShipmentRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"example":{"data":{"events":[{"buyer_notification_behavior":"","created_at":"2026-05-13T16:08:01Z","current_status":"voided","event_type":"status_changed","fulfillment_event_id":"fev_01ZYXWVUTSRQPONMLKJIHGFED","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","occurred_at":"2026-05-13T16:08:00Z","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","previous_status":"created","reason":"Label canceled before carrier pickup.","received_at":"2026-05-13T16:08:01Z","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","subject_type":"shipment"},{"buyer_notification_behavior":"","created_at":"2026-05-13T16:09:01Z","current_status":"voided","event_type":"status_changed","fulfillment_event_id":"fev_01ZYXWVUTSRQPONMLKJIHGFEC","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","occurred_at":"2026-05-13T16:09:00Z","order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","previous_status":"created","reason":"Package was repacked before pickup.","received_at":"2026-05-13T16:09:01Z","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","subject_type":"package"}],"packages":[{"carrier":"ups","created_at":"2026-05-13T16:01:00Z","dimensions":{"height":4,"length":8,"unit":"in","width":6},"external_reference_id":"pkg_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","metadata":{"box":"small"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_id":"pkg_01ABCDEFGHIJKLMNOPQRSTUVWX","service_code":"ground","shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","status":"voided","supported_actions":["mark_packed","mark_shipped","mark_in_transit","mark_out_for_delivery","mark_delivered","mark_delivery_attempted","mark_exception"],"tracking_number":"1Z999AA10123456784","tracking_url":"https://track.example.com/1Z999AA10123456784","updated_at":"2026-05-13T16:08:01Z","version":1,"weight":{"unit":"lb","value":1.2}}],"shipment":{"created_at":"2026-05-13T15:59:00Z","direction":"outbound","external_reference_id":"ship_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","handed_off_at":"2026-05-13T16:00:00Z","metadata":{"warehouse":"east"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_count":0,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","shipped_at":"2026-05-13T16:00:00Z","status":"voided","updated_at":"2026-05-13T16:08:01Z","version":1}},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/VoidShipmentResponse"}}},"description":"The voided shipment, affected packages, and timeline events.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"order not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Order, fulfillment, or shipment not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"SHIPMENT_CHANGED","details":[{"code":"SHIPMENT_CHANGED","current_resource":{"created_at":"2026-05-13T15:59:00Z","direction":"outbound","external_reference_id":"ship_789","external_system":"merchant_wms","fulfillment_id":"ful_01ABCDEFGHIJKLMNOPQRSTUVWX","handed_off_at":"2026-05-13T16:00:00Z","metadata":{"warehouse":"east"},"order_id":"ord_01ABCDEFGHIJKLMNOPQRSTUVWX","package_count":0,"shipment_id":"shp_01ABCDEFGHIJKLMNOPQRSTUVWX","shipped_at":"2026-05-13T16:00:00Z","status":"created","updated_at":"2026-05-13T16:00:00Z","version":1},"current_status":"created","current_version":1,"message":"the shipment changed","param":"expected_version","remediation":{"next_steps":"Read the current shipment and retry with its version as expected_version.","retryable":true}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"expected_version does not match the current shipment version; read the shipment and retry","param":"expected_version","remediation":{"next_steps":"Read the current shipment and retry with its version as expected_version.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The shipment version changed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Void shipment","tags":["fulfillment"],"x-flint-error-codes":["AUTH_REQUIRED","FULFILLMENT_APPROVAL_REQUIRED","FULFILLMENT_COMPLETED","FULFILLMENT_COMPLETED_DETAILS_REPLACEMENT","FULFILLMENT_COMPLETION_TIMESTAMP_CONFLICT","FULFILLMENT_EVENT_SUBJECT_INVALID","FULFILLMENT_REASON_INVALID","FULFILLMENT_REQUIREMENT_REQUIRED","FULFILLMENT_SCHEDULE_NOT_ALLOWED","FULFILLMENT_SCHEDULE_REQUIRED","FULFILLMENT_TERMINAL","FULFILLMENT_TYPE_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_EXPECTED_VERSION","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SHIPMENT_CHANGED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.orders.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.orders.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/subscription-plans":{"get":{"description":"Returns a paginated list of subscription plans for the authenticated merchant.","operationId":"listSubscriptionPlans","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by subscription plan status.","in":"query","name":"status","required":false,"schema":{"enum":["active","archived"],"type":"string","x-enum-descriptions":["Active.","Archived."],"x-flint-enum":"open"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search across subscription plan ID, external reference ID, name, and description.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["name","created_at","updated_at"],"type":"string","x-enum-descriptions":["Name.","Created at.","Updated at."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"RFC3339 lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"billing_interval":"monthly","billing_interval_count":1,"created_at":"2026-03-17T14:30:00Z","currency":"USD","images":[],"line_items":[{"name":"Membership","quantity":1,"subscription_plan_line_item_id":"spli_123","unit_price_money":{"amount":2500,"currency":"USD"}}],"merchant_id":"mer_123","metadata":{"segment":"gold"},"name":"Monthly Membership","plan_id":"plan_123","status":"active","updated_at":"2026-03-17T14:30:00Z","version":1}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SubscriptionPlanListResponse"}}},"description":"A page of subscription plans.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List subscription plans","tags":["subscription_plans"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.subscription_plans.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.subscription_plans.read","commerce.subscription_plans.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates a subscription plan for the authenticated merchant.","operationId":"createSubscriptionPlan","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"billing_interval":"monthly","billing_interval_count":1,"currency":"USD","line_items":[{"name":"Membership","quantity":1,"unit_price_money":{"amount":2500,"currency":"USD"}}],"metadata":{"segment":"gold"},"name":"Monthly Membership"},"schema":{"$ref":"#/components/schemas/CreateSubscriptionPlanRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"billing_interval":"monthly","billing_interval_count":1,"created_at":"2026-03-17T14:30:00Z","currency":"USD","images":[],"line_items":[{"name":"Membership","quantity":1,"subscription_plan_line_item_id":"spli_123","unit_price_money":{"amount":2500,"currency":"USD"}}],"merchant_id":"mer_123","metadata":{"segment":"gold"},"name":"Monthly Membership","plan_id":"plan_123","status":"active","updated_at":"2026-03-17T14:30:00Z","version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SubscriptionPlanResponse"}}},"description":"The created subscription plan.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The image source is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create subscription plan","tags":["subscription_plans"],"x-flint-error-codes":["AUTH_REQUIRED","DUPLICATE_IMAGE_EXTERNAL_REFERENCE_ID","DUPLICATE_IMAGE_SOURCE","IMAGE_ANIMATION_UNSUPPORTED","IMAGE_ASSET_NOT_ATTACHABLE","IMAGE_ASSET_NOT_FOUND","IMAGE_DIMENSIONS_EXCEEDED","IMAGE_FORMAT_UNSUPPORTED","IMAGE_GALLERY_LIMIT_EXCEEDED","IMAGE_INGESTION_COUNT_EXCEEDED","IMAGE_INGESTION_EXPIRED","IMAGE_INGESTION_IN_PROGRESS","IMAGE_INGESTION_RESTART_REQUIRED","IMAGE_NOT_ATTACHABLE","IMAGE_OWNER_NOT_MUTABLE","IMAGE_PIXEL_BUDGET_EXCEEDED","IMAGE_PROCESSING_CAPACITY_EXCEEDED","IMAGE_PROCESSING_FAILED","IMAGE_PROCESSING_TIMEOUT","IMAGE_SOURCE_FETCH_FAILED","IMAGE_SOURCE_NOT_PUBLIC","IMAGE_SOURCE_TIMEOUT","IMAGE_SOURCE_TOO_LARGE","IMAGE_SOURCE_UNAVAILABLE","IMAGE_SOURCE_URL_INVALID","IMAGE_STORAGE_QUOTA_EXCEEDED","IMAGE_URL_INVALID","IMAGE_URL_MUST_BE_CANONICAL","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_IMAGE_ALT","INVALID_IMAGE_EXTERNAL_REFERENCE_ID","INVALID_IMAGE_GALLERY","INVALID_REQUEST","NORMALIZED_IMAGE_TOO_LARGE","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.subscription_plans.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.subscription_plans.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/subscription-plans/{plan_id}":{"delete":{"description":"Retires a subscription plan. Plans with active subscriptions cannot be retired.","operationId":"deleteSubscriptionPlan","parameters":[{"description":"Flint subscription plan ID.","in":"path","name":"plan_id","required":true,"schema":{"type":"string"}},{"description":"Optional subscription plan version last read by the caller.","in":"query","name":"expected_version","required":false,"schema":{"format":"uint64","minimum":1,"type":"integer"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"billing_interval":"monthly","billing_interval_count":1,"created_at":"2026-03-17T14:30:00Z","currency":"USD","images":[],"line_items":[{"name":"Membership","quantity":1,"subscription_plan_line_item_id":"spli_123","unit_price_money":{"amount":2500,"currency":"USD"}}],"merchant_id":"mer_123","metadata":{"segment":"gold"},"name":"Monthly Membership","plan_id":"plan_123","status":"archived","updated_at":"2026-03-17T14:30:00Z","version":2},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SubscriptionPlanResponse"}}},"description":"The retired subscription plan.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"subscription plan not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Subscription plan not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Retire subscription plan","tags":["subscription_plans"],"x-flint-error-codes":["AUTH_REQUIRED","CONCURRENT_MODIFICATION","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_EXPECTED_VERSION","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.subscription_plans.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.subscription_plans.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"},"get":{"description":"Returns a single subscription plan by ID.","operationId":"getSubscriptionPlan","parameters":[{"description":"Flint subscription plan ID.","in":"path","name":"plan_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"billing_interval":"monthly","billing_interval_count":1,"created_at":"2026-03-17T14:30:00Z","currency":"USD","images":[],"line_items":[{"name":"Membership","quantity":1,"subscription_plan_line_item_id":"spli_123","unit_price_money":{"amount":2500,"currency":"USD"}}],"merchant_id":"mer_123","metadata":{"segment":"gold"},"name":"Monthly Membership","plan_id":"plan_123","status":"active","updated_at":"2026-03-17T14:30:00Z","version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SubscriptionPlanResponse"}}},"description":"The requested subscription plan.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"subscription plan not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Subscription plan not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get subscription plan","tags":["subscription_plans"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.subscription_plans.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.subscription_plans.read","commerce.subscription_plans.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Applies a sparse update to mutable subscription plan fields. Line items are mutated through the subscription plan line-item endpoints.","operationId":"updateSubscriptionPlan","parameters":[{"description":"Flint subscription plan ID.","in":"path","name":"plan_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"description":"Updated recurring membership plan","metadata":{"segment":"vip"}},"schema":{"$ref":"#/components/schemas/UpdateSubscriptionPlanRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"billing_interval":"monthly","billing_interval_count":1,"created_at":"2026-03-17T14:30:00Z","currency":"USD","images":[],"line_items":[{"name":"Membership","quantity":1,"subscription_plan_line_item_id":"spli_123","unit_price_money":{"amount":2500,"currency":"USD"}}],"merchant_id":"mer_123","metadata":{"segment":"gold"},"name":"Monthly Membership","plan_id":"plan_123","status":"active","updated_at":"2026-03-17T14:30:00Z","version":1},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SubscriptionPlanResponse"}}},"description":"The updated subscription plan.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"subscription plan not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Subscription plan not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"502":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The image source is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Image processing timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update subscription plan","tags":["subscription_plans"],"x-flint-error-codes":["AUTH_REQUIRED","CONCURRENT_MODIFICATION","DUPLICATE_IMAGE_EXTERNAL_REFERENCE_ID","DUPLICATE_IMAGE_SOURCE","EXPECTED_VERSION_REQUIRED","IMAGE_ANIMATION_UNSUPPORTED","IMAGE_ASSET_NOT_ATTACHABLE","IMAGE_ASSET_NOT_FOUND","IMAGE_DIMENSIONS_EXCEEDED","IMAGE_FORMAT_UNSUPPORTED","IMAGE_GALLERY_LIMIT_EXCEEDED","IMAGE_INGESTION_COUNT_EXCEEDED","IMAGE_INGESTION_EXPIRED","IMAGE_INGESTION_IN_PROGRESS","IMAGE_INGESTION_RESTART_REQUIRED","IMAGE_NOT_ATTACHABLE","IMAGE_OWNER_NOT_MUTABLE","IMAGE_PIXEL_BUDGET_EXCEEDED","IMAGE_PROCESSING_CAPACITY_EXCEEDED","IMAGE_PROCESSING_FAILED","IMAGE_PROCESSING_TIMEOUT","IMAGE_SOURCE_FETCH_FAILED","IMAGE_SOURCE_NOT_PUBLIC","IMAGE_SOURCE_TIMEOUT","IMAGE_SOURCE_TOO_LARGE","IMAGE_SOURCE_UNAVAILABLE","IMAGE_SOURCE_URL_INVALID","IMAGE_STORAGE_QUOTA_EXCEEDED","IMAGE_URL_INVALID","IMAGE_URL_MUST_BE_CANONICAL","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_EXPECTED_VERSION","INVALID_IMAGE_ALT","INVALID_IMAGE_EXTERNAL_REFERENCE_ID","INVALID_IMAGE_GALLERY","INVALID_REQUEST","NORMALIZED_IMAGE_TOO_LARGE","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.subscription_plans.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.subscription_plans.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/subscriptions":{"get":{"description":"Returns a paginated list of subscriptions for the authenticated merchant.","operationId":"listSubscriptions","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by subscription status. Repeat the parameter or pass comma-separated values to match multiple statuses.","explode":true,"in":"query","name":"status","required":false,"schema":{"items":{"enum":["trialing","active","paused","past_due","canceled","incomplete"],"type":"string","x-enum-descriptions":["Trialing.","Active.","Paused.","Past due.","Canceled.","Incomplete."],"x-flint-enum":"open"},"type":"array"},"style":"form"},{"description":"Filter by the system that supplies billing dates.","in":"query","name":"billing_schedule_owner","required":false,"schema":{"enum":["flint","external"],"type":"string","x-enum-descriptions":["Flint.","External."],"x-flint-enum":"closed"}},{"description":"Filter external schedules by whether they need another billing date.","in":"query","name":"awaiting_billing_schedule","required":false,"schema":{"type":"boolean"}},{"description":"When true, returns subscriptions scheduled to cancel at the end of the current period that are not yet canceled. When false, returns every other subscription.","in":"query","name":"cancel_at_period_end","required":false,"schema":{"type":"boolean"}},{"description":"Filter by Flint customer ID.","in":"query","name":"customer_id","required":false,"schema":{"type":"string"}},{"description":"Filter by Flint subscription plan ID.","in":"query","name":"plan_id","required":false,"schema":{"type":"string"}},{"description":"Exact-match filter on the caller-owned external reference ID.","in":"query","name":"external_reference_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}},{"description":"Search across subscription ID, external reference ID, customer, and plan.","in":"query","name":"query","required":false,"schema":{"type":"string"}},{"description":"Sort field.","in":"query","name":"sort_by","required":false,"schema":{"enum":["created_at","updated_at","next_billing_at"],"type":"string","x-enum-descriptions":["Created at.","Updated at.","Next billing at."],"x-flint-enum":"closed"}},{"description":"Sort direction.","in":"query","name":"sort_direction","required":false,"schema":{"enum":["asc","desc"],"type":"string","x-enum-descriptions":["Asc.","Desc."],"x-flint-enum":"closed"}},{"description":"RFC3339 lower bound for created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 lower bound for updated_at.","in":"query","name":"updated_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for updated_at.","in":"query","name":"updated_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 lower bound for next_billing_at.","in":"query","name":"next_billing_at_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for next_billing_at.","in":"query","name":"next_billing_at_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"True matches past_due, incomplete, or active subscriptions with next_billing_at more than 24 hours ago. False excludes those subscriptions. Other filters still apply.","in":"query","name":"needs_attention","required":false,"schema":{"type":"boolean"}},{"description":"Supported expansions: customer, subscription_plan. Each expansion resolves with one batched lookup per page. Expansion requires commerce.subscriptions.read plus the read scope for each expanded resource. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=customer\u0026expand=subscription_plan, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["customer","subscription_plan"],"type":"string","x-enum-descriptions":["Customer.","Subscription plan."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Subscription list","value":{"data":[{"billing_anchor_day":15,"billing_interval":"monthly","billing_interval_count":1,"billing_schedule_owner":"flint","cancel_at_period_end":false,"created_at":"2026-03-17T14:30:00Z","current_period_end":"2026-04-17T14:30:00Z","current_period_start":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","metadata":{"source":"api"},"next_billing_at":"2026-04-17T14:30:00Z","next_retry_at":null,"payment_method_id":"pm_123","plan_id":"plan_123","recurring_amount_money":{"amount":4500,"currency":"USD"},"status":"active","subscription_id":"sub_123","updated_at":"2026-03-17T14:30:00Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Subscription list with expanded relationships","value":{"data":[{"billing_anchor_day":15,"billing_interval":"monthly","billing_interval_count":1,"billing_schedule_owner":"flint","cancel_at_period_end":false,"created_at":"2026-03-17T14:30:00Z","current_period_end":"2026-04-17T14:30:00Z","current_period_start":"2026-03-17T14:30:00Z","customer":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","email":"jane@example.com","name":"Jane Doe","phone":"+14155552671","updated_at":"2026-03-17T14:30:00Z"},"customer_id":"cus_123","merchant_id":"mer_123","metadata":{"source":"api"},"next_billing_at":"2026-04-17T14:30:00Z","next_retry_at":null,"payment_method_id":"pm_123","plan_id":"plan_123","recurring_amount_money":{"amount":4500,"currency":"USD"},"status":"active","subscription_id":"sub_123","subscription_plan":{"billing_interval":"monthly","billing_interval_count":1,"created_at":"2026-03-17T14:30:00Z","currency":"USD","line_items":[{"name":"Membership","quantity":1,"subscription_plan_line_item_id":"spli_123","unit_price_money":{"amount":2500,"currency":"USD"}}],"name":"Monthly Membership","plan_id":"plan_123","status":"active","updated_at":"2026-03-17T14:30:00Z"},"updated_at":"2026-03-17T14:30:00Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/SubscriptionListResponse"}}},"description":"A page of subscriptions.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List subscriptions","tags":["subscriptions"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_BILLING_SCHEDULE_OWNER","INVALID_BOOLEAN","INVALID_PAGE_SIZE","INVALID_PAGE_TOKEN","INVALID_REQUEST","INVALID_SORT_BY","INVALID_SORT_DIRECTION","INVALID_SORT_FIELD","INVALID_STATUS","INVALID_TIMESTAMP","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE","UNSUPPORTED_QUERY_PARAM"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.subscriptions.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.subscriptions.read","commerce.subscriptions.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates a subscription for the authenticated merchant.","operationId":"createSubscription","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"billing_anchor_day":15,"billing_schedule":{"owner":"flint"},"billing_start":{"type":"immediate"},"customer_id":"cus_123","metadata":{"source":"api"},"payment_method_id":"pm_123","plan_id":"plan_123"},"schema":{"$ref":"#/components/schemas/CreateSubscriptionRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"billing_anchor_day":15,"billing_interval":"monthly","billing_interval_count":1,"billing_schedule_owner":"flint","cancel_at_period_end":false,"created_at":"2026-03-17T14:30:00Z","current_period_end":"2026-04-17T14:30:00Z","current_period_start":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","metadata":{"source":"api"},"next_billing_at":"2026-04-17T14:30:00Z","next_retry_at":null,"payment_method_id":"pm_123","plan_id":"plan_123","recurring_amount_money":{"amount":4500,"currency":"USD"},"status":"active","subscription_id":"sub_123","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}},"description":"The created subscription.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create subscription","tags":["subscriptions"],"x-flint-error-codes":["AUTH_REQUIRED","CUSTOMER_DELETION_PROCESSING","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_BILLING_ANCHOR_DAY","INVALID_REQUEST","PAYMENT_METHOD_CUSTOMER_MISMATCH","PAYMENT_METHOD_NOT_ACTIVE","PAYMENT_METHOD_NOT_READY","PAYMENT_METHOD_REQUIRED","PLAN_NOT_ACTIVE","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","SERVICE_UNAVAILABLE","SUBSCRIPTION_BILLING_SCHEDULE_REQUIRED","SUBSCRIPTION_BILLING_START_INVALID","SUBSCRIPTION_EXTERNAL_BILLING_ANCHOR_NOT_ALLOWED","SUBSCRIPTION_IMPORT_PERIOD_NOT_CURRENT","SUBSCRIPTION_SERVICE_LOCATION_INVALID","SUBSCRIPTION_STARTS_AT_NOT_FUTURE","SUBSCRIPTION_STARTS_AT_TRIAL_CONFLICT","SUBSCRIPTION_START_OVERRIDE_NOT_ALLOWED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.subscriptions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.subscriptions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/subscriptions/{subscription_id}":{"get":{"description":"Returns a single subscription by ID.","operationId":"getSubscription","parameters":[{"description":"Flint subscription ID.","in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"description":"Supported expansions: customer, payment_method, subscription_plan. Expansion requires commerce.subscriptions.read plus the read scope for each expanded resource. Limits: at most 10 unique expand paths per request; path depth at most 2. Repeat expand, for example expand=customer\u0026expand=payment_method, or pass one comma-separated value.","explode":true,"in":"query","name":"expand","required":false,"schema":{"items":{"enum":["customer","payment_method","subscription_plan"],"type":"string","x-enum-descriptions":["Customer.","Payment method.","Subscription plan."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"default":{"summary":"Subscription","value":{"data":{"billing_anchor_day":15,"billing_interval":"monthly","billing_interval_count":1,"billing_schedule_owner":"flint","cancel_at_period_end":false,"created_at":"2026-03-17T14:30:00Z","current_period_end":"2026-04-17T14:30:00Z","current_period_start":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","metadata":{"source":"api"},"next_billing_at":"2026-04-17T14:30:00Z","next_retry_at":null,"payment_method_id":"pm_123","plan_id":"plan_123","recurring_amount_money":{"amount":4500,"currency":"USD"},"status":"active","subscription_id":"sub_123","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}},"expanded":{"summary":"Subscription with expanded relationships","value":{"data":{"billing_anchor_day":15,"billing_interval":"monthly","billing_interval_count":1,"billing_schedule_owner":"flint","cancel_at_period_end":false,"created_at":"2026-03-17T14:30:00Z","current_period_end":"2026-04-17T14:30:00Z","current_period_start":"2026-03-17T14:30:00Z","customer":{"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","email":"jane@example.com","name":"Jane Doe","phone":"+14155552671","updated_at":"2026-03-17T14:30:00Z"},"customer_id":"cus_123","merchant_id":"mer_123","metadata":{"source":"api"},"next_billing_at":"2026-04-17T14:30:00Z","next_retry_at":null,"payment_method":{"card":{"brand":"visa","exp_month":12,"exp_year":2030,"last4":"4242"},"created_at":"2026-03-17T14:30:00Z","customer_id":"cus_123","payment_method_id":"pm_123","status":"active","type":"card","updated_at":"2026-03-17T14:30:00Z"},"payment_method_id":"pm_123","plan_id":"plan_123","recurring_amount_money":{"amount":4500,"currency":"USD"},"status":"active","subscription_id":"sub_123","subscription_plan":{"billing_interval":"monthly","billing_interval_count":1,"created_at":"2026-03-17T14:30:00Z","currency":"USD","line_items":[{"name":"Membership","quantity":1,"subscription_plan_line_item_id":"spli_123","unit_price_money":{"amount":2500,"currency":"USD"}}],"name":"Monthly Membership","plan_id":"plan_123","status":"active","updated_at":"2026-03-17T14:30:00Z"},"updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"}}},"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}},"description":"The requested subscription.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"subscription not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Subscription not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"500":{"content":{"application/json":{"examples":{"dangling_reference":{"summary":"Dangling expansion reference","value":{"error":{"code":"DANGLING_EXPANSION_REFERENCE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The resource references another resource that could not be resolved during expansion. Contact support with the request ID.","param":"expand","remediation":{"next_steps":"Contact support with the request_id; this indicates a Flint data-integrity defect.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}},"resolution_failed":{"summary":"Expansion resolution failed","value":{"error":{"code":"EXPANSION_RESOLUTION_FAILED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Flint could not resolve the requested expansion. Contact support with the request ID if the issue persists.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"internal_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Expansion resolution failed or referenced data was inconsistent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"EXPANSION_DEPENDENCY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"A service required for the requested expansion is temporarily unavailable.","param":"expand","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A dependency required for expansion is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get subscription","tags":["subscriptions"],"x-flint-error-codes":["AUTH_REQUIRED","DANGLING_EXPANSION_REFERENCE","EXPANSION_DEPENDENCY_UNAVAILABLE","EXPANSION_RESOLUTION_FAILED","INSUFFICIENT_SCOPE","INTERNAL_ERROR","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.subscriptions.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.subscriptions.read","commerce.subscriptions.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Updates mutable subscription fields such as payment_method_id and metadata.","operationId":"updateSubscription","parameters":[{"description":"Flint subscription ID.","in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"metadata":{"source":"customer_portal"},"payment_method_id":"pm_456"},"schema":{"$ref":"#/components/schemas/UpdateSubscriptionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"billing_anchor_day":15,"billing_interval":"monthly","billing_interval_count":1,"billing_schedule_owner":"flint","cancel_at_period_end":false,"created_at":"2026-03-17T14:30:00Z","current_period_end":"2026-04-17T14:30:00Z","current_period_start":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","metadata":{"source":"api"},"next_billing_at":"2026-04-17T14:30:00Z","next_retry_at":null,"payment_method_id":"pm_123","plan_id":"plan_123","recurring_amount_money":{"amount":4500,"currency":"USD"},"status":"active","subscription_id":"sub_123","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}},"description":"The updated subscription.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"subscription not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Subscription not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update subscription","tags":["subscriptions"],"x-flint-error-codes":["AUTH_REQUIRED","CONCURRENT_MODIFICATION","CUSTOMER_DELETION_PROCESSING","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","NO_FIELDS_TO_UPDATE","PAYMENT_METHOD_CUSTOMER_MISMATCH","PAYMENT_METHOD_NOT_ACTIVE","PAYMENT_METHOD_NOT_READY","PAYMENT_METHOD_REQUIRED","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SUBSCRIPTION_CANCELED","USE_CANCEL_SUBSCRIPTION"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.subscriptions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.subscriptions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/subscriptions/{subscription_id}/billing-schedule":{"patch":{"description":"Sets the next billing date, clears an external schedule while it awaits a date, or transfers schedule ownership. The response carries the updated subscription.","operationId":"updateSubscriptionBillingSchedule","parameters":[{"description":"Flint subscription ID.","in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"initiated_by":"integration","next_billing_at":"2026-05-17T14:30:00Z","owner":"external"},"schema":{"$ref":"#/components/schemas/UpdateSubscriptionBillingScheduleRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"billing_anchor_day":15,"billing_interval":"monthly","billing_interval_count":1,"billing_schedule_owner":"flint","cancel_at_period_end":false,"created_at":"2026-03-17T14:30:00Z","current_period_end":"2026-04-17T14:30:00Z","current_period_start":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","metadata":{"source":"api"},"next_billing_at":"2026-04-17T14:30:00Z","next_retry_at":null,"payment_method_id":"pm_123","plan_id":"plan_123","recurring_amount_money":{"amount":4500,"currency":"USD"},"status":"active","subscription_id":"sub_123","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}},"description":"The updated subscription.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid schedule.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"subscription not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Subscription not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"SUBSCRIPTION_SCHEDULE_MUTATION_NOT_ALLOWED","current_status":"past_due","details":[{"code":"SUBSCRIPTION_SCHEDULE_MUTATION_NOT_ALLOWED","current_status":"past_due","current_version":4,"message":"The subscription's current status blocks this operation","param":"status","remediation":{"next_steps":"Read the current status in error details and wait for recovery or choose a lifecycle action that applies.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The billing schedule cannot be changed in the subscription's current status.","param":"subscription_id","remediation":{"next_steps":"Read the current status in error details and wait for recovery or choose a lifecycle action that applies.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Schedule change conflicts with the current subscription state.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Update subscription billing schedule","tags":["subscriptions"],"x-flint-error-codes":["AUTH_REQUIRED","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_BILLING_SCHEDULE_OWNER","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SUBSCRIPTION_EXTERNAL_BILLING_ANCHOR_NOT_ALLOWED","SUBSCRIPTION_INITIATED_BY_INVALID","SUBSCRIPTION_NEXT_BILLING_AT_NOT_FUTURE","SUBSCRIPTION_NEXT_BILLING_AT_REQUIRED","SUBSCRIPTION_NEXT_BILLING_AT_TOO_FAR","SUBSCRIPTION_SCHEDULE_CLEAR_NOT_ALLOWED","SUBSCRIPTION_SCHEDULE_MUTATION_NOT_ALLOWED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.subscriptions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.subscriptions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/subscriptions/{subscription_id}/cancel":{"post":{"description":"Cancels a subscription immediately or at period end. Response may include advisory contract information.","operationId":"cancelSubscription","parameters":[{"description":"Flint subscription ID.","in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"cancel_immediately":false},"schema":{"$ref":"#/components/schemas/CancelSubscriptionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"billing_anchor_day":15,"cancel_at_period_end":true,"created_at":"2026-03-17T14:30:00Z","current_period_end":"2026-04-17T14:30:00Z","current_period_start":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","metadata":{"source":"api"},"next_billing_at":"2026-04-17T14:30:00Z","next_retry_at":null,"payment_method_id":"pm_123","plan_id":"plan_123","status":"active","subscription_id":"sub_123","updated_at":"2026-03-20T10:00:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/CancelSubscriptionResponse"}}},"description":"The canceled subscription state.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"subscription not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Subscription not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Cancel subscription","tags":["subscriptions"],"x-flint-error-codes":["AUTH_REQUIRED","CONCURRENT_MODIFICATION","CUSTOMER_DELETION_PROCESSING","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.subscriptions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.subscriptions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/subscriptions/{subscription_id}/pause":{"post":{"description":"Pauses a subscription immediately, optionally for a fixed number of billing cycles.","operationId":"pauseSubscription","parameters":[{"description":"Flint subscription ID.","in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"pause_duration_cycles":2},"schema":{"$ref":"#/components/schemas/PauseSubscriptionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"billing_anchor_day":15,"billing_interval":"monthly","billing_interval_count":1,"billing_schedule_owner":"flint","cancel_at_period_end":false,"created_at":"2026-03-17T14:30:00Z","current_period_end":"2026-04-17T14:30:00Z","current_period_start":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","metadata":{"source":"api"},"next_billing_at":"2026-04-17T14:30:00Z","next_retry_at":null,"payment_method_id":"pm_123","plan_id":"plan_123","recurring_amount_money":{"amount":4500,"currency":"USD"},"status":"active","subscription_id":"sub_123","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}},"description":"The paused subscription.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"subscription not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Subscription not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"CANNOT_PAUSE","current_status":"past_due","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Only active subscriptions can be paused.","param":"subscription_id","remediation":{"next_steps":"Fetch the subscription and pause it only from an active state.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Pause subscription","tags":["subscriptions"],"x-flint-error-codes":["AUTH_REQUIRED","CANNOT_PAUSE","CONCURRENT_MODIFICATION","CUSTOMER_DELETION_PROCESSING","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.subscriptions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.subscriptions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/subscriptions/{subscription_id}/payment-method":{"post":{"description":"Changes the subscription to an active payment method owned by the same customer.","operationId":"changeSubscriptionPaymentMethod","parameters":[{"description":"Flint subscription ID.","in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payment_method_id":"pm_123"},"schema":{"$ref":"#/components/schemas/ChangeSubscriptionPaymentMethodRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}},"description":"The updated subscription.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Idempotency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Change a subscription payment method","tags":["subscriptions"],"x-flint-error-codes":["AUTH_REQUIRED","CONCURRENT_MODIFICATION","CUSTOMER_DELETION_PROCESSING","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_REQUEST","PAYMENT_METHOD_CUSTOMER_MISMATCH","PAYMENT_METHOD_NOT_ACTIVE","PAYMENT_METHOD_NOT_READY","PAYMENT_METHOD_REQUIRED","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SUBSCRIPTION_CANCELED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.subscriptions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.subscriptions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/subscriptions/{subscription_id}/payment-retries":{"get":{"description":"Returns a subscription's manual payment retries, newest first.","operationId":"listSubscriptionPaymentRetries","parameters":[{"description":"Flint subscription ID.","in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by the original Idempotency-Key.","in":"query","name":"idempotency_key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"created_at":"2026-04-17T14:31:00Z","idempotency_key":"retry-2026-04-17","status":"pending","subscription_id":"sub_123","subscription_payment_retry_id":"spr_123","updated_at":"2026-04-17T14:31:00Z"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SubscriptionPaymentRetryListResponse"}}},"description":"A page of retry attempts.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List subscription payment retries","tags":["subscriptions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_PAGE_TOKEN","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","UNSUPPORTED_QUERY_PARAM"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.subscriptions.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.subscriptions.read","commerce.subscriptions.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Starts one manual collection attempt on a past-due subscription. Send no body, or an empty object. Poll the returned retry for the outcome.","operationId":"createSubscriptionPaymentRetry","parameters":[{"description":"Flint subscription ID.","in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"description":"Required durable identity for this retry attempt.","in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{},"schema":{"additionalProperties":false,"maxProperties":0,"type":"object"}}},"required":false},"responses":{"201":{"content":{"application/json":{"example":{"data":{"created_at":"2026-04-17T14:31:00Z","idempotency_key":"retry-2026-04-17","status":"pending","subscription_id":"sub_123","subscription_payment_retry_id":"spr_123","updated_at":"2026-04-17T14:31:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SubscriptionPaymentRetryResponse"}}},"description":"The durable retry attempt.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"subscription not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Subscription not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"SUBSCRIPTION_PAYMENT_RETRY_NOT_ALLOWED","current_status":"active","details":[{"code":"SUBSCRIPTION_PAYMENT_RETRY_NOT_ALLOWED","current_status":"active","current_version":4,"message":"The subscription's current status blocks this operation","param":"status","remediation":{"next_steps":"Fetch the subscription and create a retry only while its status is past_due.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"A payment retry can only be created for a past-due subscription.","param":"subscription_id","remediation":{"next_steps":"Fetch the subscription and create a retry only while its status is past_due.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Retry not allowed or idempotency key reused.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Retry subscription payment","tags":["subscriptions"],"x-flint-error-codes":["AUTH_REQUIRED","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REQUIRED","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_BODY_NOT_ALLOWED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","SUBSCRIPTION_PAYMENT_RETRY_NOT_ALLOWED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.subscriptions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.subscriptions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/subscriptions/{subscription_id}/payment-retries/{subscription_payment_retry_id}":{"get":{"description":"Returns one durable manual subscription payment retry.","operationId":"getSubscriptionPaymentRetry","parameters":[{"description":"Flint subscription ID.","in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"description":"Flint subscription payment retry ID.","in":"path","name":"subscription_payment_retry_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"created_at":"2026-04-17T14:31:00Z","idempotency_key":"retry-2026-04-17","status":"pending","subscription_id":"sub_123","subscription_payment_retry_id":"spr_123","updated_at":"2026-04-17T14:31:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SubscriptionPaymentRetryResponse"}}},"description":"The retry attempt.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"subscription not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Retry attempt not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get subscription payment retry","tags":["subscriptions"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.subscriptions.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.subscriptions.read","commerce.subscriptions.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/subscriptions/{subscription_id}/reactivate":{"post":{"description":"Clears a pending period-end cancellation without changing the current billing period.","operationId":"reactivateSubscription","parameters":[{"description":"Flint subscription ID.","in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}},"description":"The reactivated subscription.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Resource not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Idempotency conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Reactivate a subscription","tags":["subscriptions"],"x-flint-error-codes":["AUTH_REQUIRED","CONCURRENT_MODIFICATION","CUSTOMER_DELETION_PROCESSING","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_REQUEST","NO_FIELDS_TO_UPDATE","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SUBSCRIPTION_CANCELED","USE_CANCEL_SUBSCRIPTION"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.subscriptions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.subscriptions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/subscriptions/{subscription_id}/resume":{"post":{"description":"Resumes a paused subscription.","operationId":"resumeSubscription","parameters":[{"description":"Flint subscription ID.","in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"billing_anchor_day":15,"billing_interval":"monthly","billing_interval_count":1,"billing_schedule_owner":"flint","cancel_at_period_end":false,"created_at":"2026-03-17T14:30:00Z","current_period_end":"2026-04-17T14:30:00Z","current_period_start":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","metadata":{"source":"api"},"next_billing_at":"2026-04-17T14:30:00Z","next_retry_at":null,"payment_method_id":"pm_123","plan_id":"plan_123","recurring_amount_money":{"amount":4500,"currency":"USD"},"status":"active","subscription_id":"sub_123","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}},"description":"The resumed subscription.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"subscription not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Subscription not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"CANNOT_RESUME","current_status":"active","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Only paused subscriptions can be resumed.","param":"subscription_id","remediation":{"next_steps":"Fetch the subscription and resume it only from a paused state.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Resume subscription","tags":["subscriptions"],"x-flint-error-codes":["AUTH_REQUIRED","CANNOT_RESUME","CANNOT_RESUME_INITIAL_PAYMENT_PENDING","CANNOT_RESUME_PAST_DUE_PAYMENT_REQUIRED","CONCURRENT_MODIFICATION","CUSTOMER_DELETION_PROCESSING","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.subscriptions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.subscriptions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/subscriptions/{subscription_id}/skip-cycle":{"post":{"description":"Moves the next billing date forward by one plan interval without charging the current cycle.","operationId":"skipSubscriptionCycle","parameters":[{"description":"Flint subscription ID.","in":"path","name":"subscription_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"initiated_by":"merchant"},"schema":{"$ref":"#/components/schemas/SkipSubscriptionCycleRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"billing_anchor_day":15,"billing_interval":"monthly","billing_interval_count":1,"billing_schedule_owner":"flint","cancel_at_period_end":false,"created_at":"2026-03-17T14:30:00Z","current_period_end":"2026-04-17T14:30:00Z","current_period_start":"2026-03-17T14:30:00Z","customer_id":"cus_123","merchant_id":"mer_123","metadata":{"source":"api"},"next_billing_at":"2026-04-17T14:30:00Z","next_retry_at":null,"payment_method_id":"pm_123","plan_id":"plan_123","recurring_amount_money":{"amount":4500,"currency":"USD"},"status":"active","subscription_id":"sub_123","updated_at":"2026-03-17T14:30:00Z"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}},"description":"The updated subscription.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"subscription not found","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Subscription not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"SUBSCRIPTION_SCHEDULE_MUTATION_NOT_ALLOWED","current_status":"past_due","details":[{"code":"SUBSCRIPTION_SCHEDULE_MUTATION_NOT_ALLOWED","current_status":"past_due","current_version":4,"message":"The subscription's current status blocks this operation","param":"status","remediation":{"next_steps":"Read the current status in error details and wait for recovery or choose a lifecycle action that applies.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The billing schedule cannot be changed in the subscription's current status.","param":"subscription_id","remediation":{"next_steps":"Read the current status in error details and wait for recovery or choose a lifecycle action that applies.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"conflict_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The current subscription state cannot be skipped.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Skip subscription cycle","tags":["subscriptions"],"x-flint-error-codes":["AUTH_REQUIRED","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_REUSED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","SUBSCRIPTION_INITIATED_BY_INVALID","SUBSCRIPTION_SCHEDULE_MUTATION_NOT_ALLOWED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["commerce.subscriptions.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["commerce.subscriptions.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"write"}},"/v1/webhook-deliveries/{webhook_delivery_id}":{"get":{"description":"Returns one endpoint delivery and its current retry state.","operationId":"getWebhookDelivery","parameters":[{"description":"Flint webhook delivery ID.","in":"path","name":"webhook_delivery_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"automatic_attempt_count":1,"created_at":"2026-03-17T14:30:00Z","delivered_at":"2026-03-17T14:30:02Z","last_response_code":200,"max_attempts":9,"status":"delivered","updated_at":"2026-03-17T14:30:02Z","webhook_delivery_id":"wdel_123","webhook_endpoint_id":"whep_123","webhook_event_id":"whev_123"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/WebhookDeliveryResponse"}}},"description":"The selected webhook delivery.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Webhook delivery not found.","param":"webhook_delivery_id","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Webhook delivery not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get webhook delivery","tags":["webhooks"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["webhooks.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["webhooks.read","webhooks.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/webhook-deliveries/{webhook_delivery_id}/attempts":{"get":{"description":"Returns the attempts recorded for a specific webhook delivery.","operationId":"listWebhookDeliveryAttempts","parameters":[{"description":"Flint webhook delivery ID.","in":"path","name":"webhook_delivery_id","required":true,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"api_version":"2026-09-07","attempt_number":1,"completed_at":"2026-03-17T14:30:02Z","delivery_trigger":"automatic_delivery","diagnostic_category":"http_error","duration_milliseconds":982,"error_category":"webhook_http_5xx","error_message":"HTTP 502","error_summary":"The webhook endpoint returned a server error.","recommended_action":"Inspect the endpoint logs for this delivery, fix the handler, then resend the webhook event.","response_body_excerpt":"{\"error\":\"bad gateway\",\"api_token\":\"[REDACTED]\"}","response_content_type":"application/json","response_headers":"{\"Content-Type\":\"application/json\",\"X-Api-Token\":\"[REDACTED]\"}","retryable":true,"started_at":"2026-03-17T14:30:01Z","status":"failed","status_code":502,"webhook_delivery_attempt_id":"watt_123","webhook_delivery_id":"wdel_123","webhook_event_id":"whev_123"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/WebhookDeliveryAttemptListResponse"}}},"description":"Attempts for the selected delivery.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Webhook delivery not found.","param":"webhook_delivery_id","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Webhook delivery not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List webhook delivery attempts","tags":["webhooks"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["webhooks.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["webhooks.read","webhooks.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/webhook-deliveries/{webhook_delivery_id}/resend":{"post":{"description":"Sends the canonical event payload again to the delivery's current webhook endpoint URL. Safe to retry with the same Idempotency-Key.","operationId":"resendWebhookDelivery","parameters":[{"description":"Flint webhook delivery ID.","in":"path","name":"webhook_delivery_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"reason":"Endpoint was fixed after returning 500s."},"schema":{"$ref":"#/components/schemas/ResendWebhookDeliveryRequest"}}},"required":false},"responses":{"200":{"content":{"application/json":{"example":{"data":{"attempt_number":1,"attempt_status":"delivered","completed_at":"2026-03-17T14:30:02Z","delivery_status":"delivered","delivery_trigger":"manual_resend","duration_milliseconds":982,"started_at":"2026-03-17T14:30:01Z","status_code":200,"webhook_delivery_attempt_id":"watt_123","webhook_delivery_id":"wdel_123","webhook_event_id":"whev_123"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/WebhookDeliveryActionResponse"}}},"description":"The manual webhook delivery action.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Webhook delivery not found.","param":"webhook_delivery_id","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Webhook delivery not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"examples":{"delivery_in_flight":{"summary":"Automatic delivery is still running","value":{"error":{"code":"WEBHOOK_DELIVERY_IN_FLIGHT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Pending webhook deliveries cannot be resent until automatic delivery finishes.","param":"webhook_delivery_id","remediation":{"next_steps":"Wait for the active delivery attempt to finish, then retry the resend if needed.","retryable":true},"type":"conflict_error"}}},"endpoint_inactive":{"summary":"The delivery endpoint is inactive","value":{"error":{"code":"WEBHOOK_ENDPOINT_NOT_ACTIVE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The webhook endpoint must be active to resend this delivery.","param":"webhook_delivery_id","remediation":{"next_steps":"Enable the endpoint and resolve any endpoint configuration issue before resending.","retryable":false},"type":"conflict_error"}}},"payload_expired":{"summary":"The retained payload has expired","value":{"error":{"code":"WEBHOOK_EVENT_PAYLOAD_EXPIRED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The webhook event payload has expired and can no longer be resent.","param":"webhook_delivery_id","remediation":{"next_steps":"Use a newer webhook event. Expired payloads cannot be resent.","retryable":false},"type":"conflict_error"}}}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The delivery cannot currently be resent.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"WEBHOOK_DELIVERY_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Webhook delivery is unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Webhook delivery is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Resend webhook delivery","tags":["webhooks"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE","WEBHOOK_DELIVERY_IN_FLIGHT","WEBHOOK_DELIVERY_UNAVAILABLE","WEBHOOK_ENDPOINT_NOT_ACTIVE","WEBHOOK_EVENT_PAYLOAD_EXPIRED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["webhooks.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["webhooks.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/webhook-endpoints":{"get":{"description":"Returns a page of webhook endpoints for the authenticated merchant.","operationId":"listWebhookEndpoints","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter by webhook endpoint event sources. Repeat or comma-separate to include multiple sources.","in":"query","name":"event_sources","required":false,"schema":{"items":{"enum":["merchant","partner_app","installed_merchants"],"type":"string","x-enum-descriptions":["Merchant.","Partner app.","Installed merchants."],"x-flint-enum":"closed"},"type":"array"}},{"description":"Filter by partner app ID for partner-source webhook endpoints.","in":"query","name":"partner_app_id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"api_version":"2026-09-07","created_at":"2026-03-17T14:30:00Z","description":"Primary production endpoint","enabled":true,"enabled_events":["order.payment_captured","order.paid","payment_intent.succeeded"],"event_sources":["merchant"],"updated_at":"2026-03-17T14:30:00Z","url":"https://example.com/webhooks/flint","webhook_endpoint_id":"whep_123"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/WebhookEndpointListResponse"}}},"description":"A page of webhook endpoints for the authenticated merchant.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"List webhook endpoints","tags":["webhooks"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["webhooks.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["webhooks.read","webhooks.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"post":{"description":"Creates a webhook endpoint and returns the signing secret once.","operationId":"createWebhookEndpoint","parameters":[{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"description":"Primary production endpoint","enabled":true,"enabled_events":["order.payment_captured","order.paid","payment_intent.succeeded"],"event_sources":["merchant"],"url":"https://example.com/webhooks/flint"},"schema":{"$ref":"#/components/schemas/CreateWebhookEndpointRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"api_version":"2026-09-07","created_at":"2026-03-17T14:30:00Z","description":"Primary production endpoint","enabled":true,"enabled_events":["order.payment_captured","order.paid","payment_intent.succeeded"],"event_sources":["merchant"],"secret":"whsec_123","updated_at":"2026-03-17T14:30:00Z","url":"https://example.com/webhooks/flint","webhook_endpoint_id":"whep_123"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/WebhookEndpointResponse"}}},"description":"The created webhook endpoint, including the signing secret.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Create webhook endpoint","tags":["webhooks"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["webhooks.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["webhooks.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/webhook-endpoints/{webhook_endpoint_id}":{"delete":{"description":"Marks a webhook endpoint as deleted so it no longer receives events.","operationId":"deleteWebhookEndpoint","parameters":[{"description":"Flint webhook endpoint ID.","in":"path","name":"webhook_endpoint_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"success":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/ActionResponse"}}},"description":"Deletion acknowledged.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Webhook endpoint not found.","param":"webhook_endpoint_id","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Webhook endpoint not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Delete webhook endpoint","tags":["webhooks"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["webhooks.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["webhooks.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"},"get":{"description":"Returns a single webhook endpoint by ID. The signing secret is omitted after creation.","operationId":"getWebhookEndpoint","parameters":[{"description":"Flint webhook endpoint ID.","in":"path","name":"webhook_endpoint_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"api_version":"2026-09-07","created_at":"2026-03-17T14:30:00Z","description":"Primary production endpoint","enabled":true,"enabled_events":["order.payment_captured","order.paid","payment_intent.succeeded"],"event_sources":["merchant"],"updated_at":"2026-03-17T14:30:00Z","url":"https://example.com/webhooks/flint","webhook_endpoint_id":"whep_123"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/WebhookEndpointResponse"}}},"description":"The requested webhook endpoint.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Webhook endpoint not found.","param":"webhook_endpoint_id","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Webhook endpoint not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Get webhook endpoint","tags":["webhooks"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["webhooks.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["webhooks.read","webhooks.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"},"patch":{"description":"Updates the mutable fields on a webhook endpoint.","operationId":"updateWebhookEndpoint","parameters":[{"description":"Flint webhook endpoint ID.","in":"path","name":"webhook_endpoint_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"description":"Updated production endpoint","enabled":true},"schema":{"$ref":"#/components/schemas/UpdateWebhookEndpointRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"data":{"api_version":"2026-09-07","created_at":"2026-03-17T14:30:00Z","description":"Primary production endpoint","enabled":true,"enabled_events":["order.payment_captured","order.paid","payment_intent.succeeded"],"event_sources":["merchant"],"updated_at":"2026-03-17T14:30:00Z","url":"https://example.com/webhooks/flint","webhook_endpoint_id":"whep_123"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/WebhookEndpointResponse"}}},"description":"The updated webhook endpoint.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Webhook endpoint not found.","param":"webhook_endpoint_id","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Webhook endpoint not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"API_VERSION_CHANGED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API version changed. Reload the resource and review its current API version before trying again.","param":"expected_api_version","remediation":{"next_steps":"Reload the resource, review its current API version, and retry with that value as expected_api_version.","retryable":false},"type":"conflict_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"The API version changed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"BearerAuth":[]},{"ApiKeyHeader":[]}],"summary":"Update webhook endpoint","tags":["webhooks"],"x-flint-error-codes":["API_VERSION_CHANGED","AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["webhooks.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["webhooks.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/webhook-endpoints/{webhook_endpoint_id}/rotate-secret":{"post":{"description":"Rotates the signing secret for a webhook endpoint and returns the new secret once.","operationId":"rotateWebhookSecret","parameters":[{"description":"Flint webhook endpoint ID.","in":"path","name":"webhook_endpoint_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"Optional request ID for tracing.","in":"header","name":"X-Request-Id","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"secret":"whsec_rotated_123"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/WebhookSecretRotationResponse"}}},"description":"The rotated webhook secret.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Webhook endpoint not found.","param":"webhook_endpoint_id","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Webhook endpoint not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Rotate webhook secret","tags":["webhooks"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["webhooks.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["webhooks.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"sensitive_write"}},"/v1/webhook-endpoints/{webhook_endpoint_id}/test-events":{"post":{"description":"Creates and delivers a synthetic test webhook event to one active webhook endpoint. Safe to retry with the same Idempotency-Key.","operationId":"createWebhookTestEvent","parameters":[{"description":"Flint webhook endpoint ID.","in":"path","name":"webhook_endpoint_id","required":true,"schema":{"type":"string"}},{"description":"Optional idempotency key for safe retries.","in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"event_type":"payment_intent.succeeded"},"schema":{"$ref":"#/components/schemas/CreateWebhookTestEventRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"example":{"data":{"attempt_number":1,"attempt_status":"delivered","completed_at":"2026-03-17T14:30:02Z","delivery_status":"delivered","delivery_trigger":"test_event","duration_milliseconds":982,"started_at":"2026-03-17T14:30:01Z","status_code":200,"webhook_delivery_attempt_id":"watt_123","webhook_delivery_id":"wdel_123","webhook_event_id":"whev_123"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/WebhookDeliveryActionResponse"}}},"description":"The synthetic webhook event delivery action.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Idempotency-Key":{"description":"Effective idempotency key for the request. Flint returns a generated value when the request omitted one.","schema":{"type":"string"}},"Idempotency-Replayed":{"description":"Set to true when Flint served the response from a completed idempotency replay.","schema":{"enum":["true"],"type":"string","x-enum-descriptions":["True."],"x-flint-enum":"closed"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Webhook endpoint not found.","param":"webhook_endpoint_id","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Webhook endpoint not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"409":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Conflict.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"SERVICE_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The service is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the error persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"504":{"content":{"application/json":{"example":{"error":{"code":"REQUEST_TIMEOUT","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"The request timed out.","remediation":{"next_steps":"Retry with exponential backoff. Contact support with the request_id if the timeout persists.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"timeout_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"A required payment, money movement, or delivery provider timed out.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Create webhook test event","tags":["webhooks"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","REQUEST_TIMEOUT","RESOURCE_NOT_FOUND","SERVICE_UNAVAILABLE"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["webhooks.write"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["webhooks.write"],"x-flint-required-scopes-mode":"all","x-flint-route-class":"external_provider_action"}},"/v1/webhook-event-types":{"get":{"description":"Returns the webhook event types that can be used in enabled_events and event_type filters, grouped by the event source each type is valid for.","operationId":"listWebhookEventTypes","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"description":"An order became fully paid. Use order.payment_captured for each captured increment.","event_sources":["merchant","installed_merchants"],"event_type":"order.paid"},{"description":"A partner app install was created.","event_sources":["partner_app"],"event_type":"partner_app.install.created"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/WebhookEventTypeListResponse"}}},"description":"Webhook event types supported by the public API.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List webhook event types","tags":["webhooks"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["webhooks.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["webhooks.read","webhooks.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/webhook-events":{"get":{"description":"Returns recent canonical webhook events for the authenticated merchant.","operationId":"listWebhookEvents","parameters":[{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"Filter to events that have a delivery for this webhook endpoint.","in":"query","name":"webhook_endpoint_id","required":false,"schema":{"type":"string"}},{"description":"Filter to events that have a delivery with this status.","in":"query","name":"delivery_status","required":false,"schema":{"enum":["pending","delivered","failed","suppressed"],"type":"string","x-enum-descriptions":["Pending.","Delivered.","Failed.","Suppressed."],"x-flint-enum":"open"}},{"description":"Filter by webhook event source. Repeat or comma-separate to include multiple sources.","in":"query","name":"event_source","required":false,"schema":{"items":{"enum":["merchant","partner_app","installed_merchants"],"type":"string","x-enum-descriptions":["Merchant.","Partner app.","Installed merchants."],"x-flint-enum":"closed"},"type":"array"}},{"description":"Filter by partner app ID for partner-source webhook events.","in":"query","name":"partner_app_id","required":false,"schema":{"type":"string"}},{"description":"Filter by webhook event type.","in":"query","name":"event_type","required":false,"schema":{"enum":["balance.updated","balance_transaction.created","balance_transaction.updated","capability.updated","checkout_session.closed","checkout_session.completed","checkout_session.expired","checkout_session.invalidated","credit_note.allocation_created","credit_note.allocation_reversed","credit_note.created","credit_note.issued","credit_note.updated","credit_note.voided","customer.created","customer.deletion_completed","customer.deletion_rejected","customer.deletion_requested","customer.updated","delivery_location_set.activated","delivery_location_set.archived","delivery_location_set.created","delivery_location_set.deactivated","delivery_location_set.updated","delivery_method.activated","delivery_method.archived","delivery_method.created","delivery_method.deactivated","delivery_method.updated","delivery_profile.activated","delivery_profile.archived","delivery_profile.created","delivery_profile.deactivated","delivery_profile.updated","delivery_rate.archived","delivery_rate.created","delivery_rate.updated","delivery_rate_callback.activated","delivery_rate_callback.archived","delivery_rate_callback.created","delivery_rate_callback.deactivated","delivery_rate_callback.updated","delivery_revocation.created","delivery_selection.committed","delivery_zone.activated","delivery_zone.archived","delivery_zone.created","delivery_zone.deactivated","delivery_zone.updated","dispute.closed","dispute.created","dispute.lost","dispute.needs_response","dispute.prevented","dispute.updated","dispute.warning_closed","dispute.won","fraud_warning.created","fraud_warning.updated","inventory.action_required","inventory.count.applied","inventory.level.updated","inventory.receipt.created","inventory.reservation.at_risk","inventory.reservation.closed","inventory.reservation.committed","inventory.reservation.consumed","inventory.reservation.created","inventory.reservation.hold_expired","inventory.reservation.released","inventory.shortage.detected","inventory.transfer.closed","inventory.transfer.departed","inventory.transfer.lost","inventory.transfer.received","inventory.transfer.returned","invoice.collection_block_resolved","invoice.collection_blocked","invoice.created","invoice.credited","invoice.delivery_failed","invoice.delivery_succeeded","invoice.issue_failed","invoice.issued","invoice.late_fee_assessed","invoice.late_fee_due","invoice.late_fee_waived","invoice.manual_payment_recorded","invoice.manual_payment_reversed","invoice.marked_uncollectible","invoice.overdue","invoice.paid","invoice.partially_paid","invoice.partially_refunded","invoice.payment_attempt_canceled","invoice.payment_attempt_expired","invoice.payment_failed","invoice.payment_processing","invoice.refunded","invoice.reminder_due","invoice.sent","invoice.updated","invoice.voided","merchant.readiness.updated","merchant_billing_balance.updated","merchant_subscription_invoice.issued","merchant_subscription_invoice.updated","order.closed","order.created","order.fulfillment.completed","order.fulfillment.created","order.fulfillment.event.created","order.fulfillment.package.created","order.fulfillment.package.updated","order.fulfillment.shipment.created","order.fulfillment.shipment.updated","order.fulfillment.status_changed","order.fulfillment.updated","order.inventory_action_required","order.inventory_exception.created","order.inventory_exception.resolved","order.paid","order.partially_paid","order.payment_authorization_canceled","order.payment_authorization_expired","order.payment_authorized","order.payment_captured","order.refunded","order.updated","partner_app.install.created","partner_app.install.environment_grant.created","partner_app.install.environment_grant.revoked","partner_app.install.permissions_updated","partner_app.install.revoked","partner_app.install.updated","payment_intent.canceled","payment_intent.fulfillment_hold.updated","payment_intent.payment_failed","payment_intent.processing","payment_intent.requires_action","payment_intent.requires_capture","payment_intent.succeeded","payment_method.failed","payment_method.removed","payment_method.saved","payout.canceled","payout.created","payout.failed","payout.paid","payout.reversed","payout.updated","payout_destination.created","payout_destination.deleted","payout_destination.disabled","payout_destination.updated","payout_settings.updated","refund.created","refund.failed","refund.updated","report.failed","report.succeeded","return.canceled","return.completed","return.created","return.decision_recorded","return.reopened","return.updated","return_disposition.created","return_disposition.updated","return_inspection.acceptance_decided","return_inspection.created","return_inspection.superseded","return_receipt.created","return_receipt.superseded","return_receipt.verified","return_resolution.created","return_resolution.updated","review.closed","review.opened","subscription.activated","subscription.canceled","subscription.created","subscription.dunning_exhausted","subscription.past_due","subscription.paused","subscription.payment_failed","subscription.payment_succeeded","subscription.renewal_upcoming","subscription.resumed","subscription.trial_ending","subscription.updated"],"type":"string","x-enum-descriptions":["Balance.updated.","Balance transaction.created.","Balance transaction.updated.","Capability.updated.","Checkout session.closed.","Checkout session.completed.","Checkout session.expired.","Checkout session.invalidated.","Credit note.allocation created.","Credit note.allocation reversed.","Credit note.created.","Credit note.issued.","Credit note.updated.","Credit note.voided.","Customer.created.","Customer.deletion completed.","Customer.deletion rejected.","Customer.deletion requested.","Customer.updated.","Delivery location set.activated.","Delivery location set.archived.","Delivery location set.created.","Delivery location set.deactivated.","Delivery location set.updated.","Delivery method.activated.","Delivery method.archived.","Delivery method.created.","Delivery method.deactivated.","Delivery method.updated.","Delivery profile.activated.","Delivery profile.archived.","Delivery profile.created.","Delivery profile.deactivated.","Delivery profile.updated.","Delivery rate.archived.","Delivery rate.created.","Delivery rate.updated.","Delivery rate callback.activated.","Delivery rate callback.archived.","Delivery rate callback.created.","Delivery rate callback.deactivated.","Delivery rate callback.updated.","Delivery revocation.created.","Delivery selection.committed.","Delivery zone.activated.","Delivery zone.archived.","Delivery zone.created.","Delivery zone.deactivated.","Delivery zone.updated.","Dispute.closed.","Dispute.created.","Dispute.lost.","Dispute.needs response.","Dispute.prevented.","Dispute.updated.","Dispute.warning closed.","Dispute.won.","Fraud warning.created.","Fraud warning.updated.","Inventory.action required.","Inventory.count.applied.","Inventory.level.updated.","Inventory.receipt.created.","Inventory.reservation.at risk.","Inventory.reservation.closed.","Inventory.reservation.committed.","Inventory.reservation.consumed.","Inventory.reservation.created.","Inventory.reservation.hold expired.","Inventory.reservation.released.","Inventory.shortage.detected.","Inventory.transfer.closed.","Inventory.transfer.departed.","Inventory.transfer.lost.","Inventory.transfer.received.","Inventory.transfer.returned.","Invoice.collection block resolved.","Invoice.collection blocked.","Invoice.created.","Invoice.credited.","Invoice.delivery failed.","Invoice.delivery succeeded.","Invoice.issue failed.","Invoice.issued.","Invoice.late fee assessed.","Invoice.late fee due.","Invoice.late fee waived.","Invoice.manual payment recorded.","Invoice.manual payment reversed.","Invoice.marked uncollectible.","Invoice.overdue.","Invoice.paid.","Invoice.partially paid.","Invoice.partially refunded.","Invoice.payment attempt canceled.","Invoice.payment attempt expired.","Invoice.payment failed.","Invoice.payment processing.","Invoice.refunded.","Invoice.reminder due.","Invoice.sent.","Invoice.updated.","Invoice.voided.","Merchant.readiness.updated.","Merchant billing balance.updated.","Merchant subscription invoice.issued.","Merchant subscription invoice.updated.","Order.closed.","Order.created.","Order.fulfillment.completed.","Order.fulfillment.created.","Order.fulfillment.event.created.","Order.fulfillment.package.created.","Order.fulfillment.package.updated.","Order.fulfillment.shipment.created.","Order.fulfillment.shipment.updated.","Order.fulfillment.status changed.","Order.fulfillment.updated.","Order.inventory action required.","Order.inventory exception.created.","Order.inventory exception.resolved.","Order.paid.","Order.partially paid.","Order.payment authorization canceled.","Order.payment authorization expired.","Order.payment authorized.","Order.payment captured.","Order.refunded.","Order.updated.","Partner app.install.created.","Partner app.install.environment grant.created.","Partner app.install.environment grant.revoked.","Partner app.install.permissions updated.","Partner app.install.revoked.","Partner app.install.updated.","Payment intent.canceled.","Payment intent.fulfillment hold.updated.","Payment intent.payment failed.","Payment intent.processing.","Payment intent.requires action.","Payment intent.requires capture.","Payment intent.succeeded.","Payment method.failed.","Payment method.removed.","Payment method.saved.","Payout.canceled.","Payout.created.","Payout.failed.","Payout.paid.","Payout.reversed.","Payout.updated.","Payout destination.created.","Payout destination.deleted.","Payout destination.disabled.","Payout destination.updated.","Payout settings.updated.","Refund.created.","Refund.failed.","Refund.updated.","Report.failed.","Report.succeeded.","Return.canceled.","Return.completed.","Return.created.","Return.decision recorded.","Return.reopened.","Return.updated.","Return disposition.created.","Return disposition.updated.","Return inspection.acceptance decided.","Return inspection.created.","Return inspection.superseded.","Return receipt.created.","Return receipt.superseded.","Return receipt.verified.","Return resolution.created.","Return resolution.updated.","Review.closed.","Review.opened.","Subscription.activated.","Subscription.canceled.","Subscription.created.","Subscription.dunning exhausted.","Subscription.past due.","Subscription.paused.","Subscription.payment failed.","Subscription.payment succeeded.","Subscription.renewal upcoming.","Subscription.resumed.","Subscription.trial ending.","Subscription.updated."],"x-flint-enum":"closed"}},{"description":"Filter by affected resource type.","in":"query","name":"resource_type","required":false,"schema":{"enum":["balance","balance_transaction","capability","checkout_session","customer","dispute","fraud_warning","invoice","merchant","inventory_count","inventory_level","inventory_reservation","inventory_reservation_line","inventory_receipt","inventory_transfer","order","payment_intent","payment_method","payout","payout_destination","payout_settings","refund","return","return_disposition","return_inspection","return_receipt","return_resolution","review","subscription"],"type":"string","x-enum-descriptions":["Balance.","Balance transaction.","Capability.","Checkout session.","Customer.","Dispute.","Fraud warning.","Invoice.","Merchant.","Inventory count.","Inventory level.","Inventory reservation.","Inventory reservation line.","Inventory receipt.","Inventory transfer.","Order.","Payment intent.","Payment method.","Payout.","Payout destination.","Payout settings.","Refund.","Return.","Return disposition.","Return inspection.","Return receipt.","Return resolution.","Review.","Subscription."],"x-flint-enum":"closed"}},{"description":"Filter by affected resource ID.","in":"query","name":"resource_id","required":false,"schema":{"type":"string"}},{"description":"Filter by API request log ID associated with the event.","in":"query","name":"api_request_log_id","required":false,"schema":{"type":"string"}},{"description":"Filter by request ID associated with the event.","in":"query","name":"request_id","required":false,"schema":{"type":"string"}},{"description":"Filter by correlation ID associated with the event.","in":"query","name":"correlation_id","required":false,"schema":{"type":"string"}},{"description":"RFC3339 lower bound for webhook event created_at.","in":"query","name":"created_after","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"RFC3339 upper bound for webhook event created_at.","in":"query","name":"created_before","required":false,"schema":{"example":"2026-03-17T14:30:00Z","format":"date-time","type":"string"}},{"description":"Optional comma-separated expansions. Use test_events to include synthetic webhook test events.","explode":false,"in":"query","name":"include","required":false,"schema":{"items":{"enum":["test_events"],"type":"string","x-enum-descriptions":["Test events."],"x-flint-enum":"closed"},"type":"array"},"style":"form"},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"api_request_log_id":"rlog_123","correlation_id":"rlog_123","created_at":"2026-03-17T14:30:00Z","event_origin":"business_event","event_source":"merchant","event_type":"order.paid","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","resource_id":"ord_123","resource_type":"order","test":false,"webhook_event_id":"whev_123"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/WebhookEventListResponse"}}},"description":"A page of webhook events.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List webhook events","tags":["webhooks"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["webhooks.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["webhooks.read","webhooks.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/webhook-events/stream":{"get":{"description":"Streams canonical merchant webhook events created after the connection opens or after the supplied event ID. SSE event IDs are resumable webhook event IDs. Control records include ready, gap, withheld, and disconnect. Gap and withheld records advance the resumable cursor even when a resource payload is expired or hidden by API-key scope.","operationId":"streamWebhookEvents","parameters":[{"description":"Filter by canonical merchant webhook event type.","in":"query","name":"event_type","required":false,"schema":{"enum":["balance.updated","balance_transaction.created","balance_transaction.updated","capability.updated","checkout_session.closed","checkout_session.completed","checkout_session.expired","checkout_session.invalidated","credit_note.allocation_created","credit_note.allocation_reversed","credit_note.created","credit_note.issued","credit_note.updated","credit_note.voided","customer.created","customer.deletion_completed","customer.deletion_rejected","customer.deletion_requested","customer.updated","delivery_location_set.activated","delivery_location_set.archived","delivery_location_set.created","delivery_location_set.deactivated","delivery_location_set.updated","delivery_method.activated","delivery_method.archived","delivery_method.created","delivery_method.deactivated","delivery_method.updated","delivery_profile.activated","delivery_profile.archived","delivery_profile.created","delivery_profile.deactivated","delivery_profile.updated","delivery_rate.archived","delivery_rate.created","delivery_rate.updated","delivery_rate_callback.activated","delivery_rate_callback.archived","delivery_rate_callback.created","delivery_rate_callback.deactivated","delivery_rate_callback.updated","delivery_revocation.created","delivery_selection.committed","delivery_zone.activated","delivery_zone.archived","delivery_zone.created","delivery_zone.deactivated","delivery_zone.updated","dispute.closed","dispute.created","dispute.lost","dispute.needs_response","dispute.prevented","dispute.updated","dispute.warning_closed","dispute.won","fraud_warning.created","fraud_warning.updated","inventory.action_required","inventory.count.applied","inventory.level.updated","inventory.receipt.created","inventory.reservation.at_risk","inventory.reservation.closed","inventory.reservation.committed","inventory.reservation.consumed","inventory.reservation.created","inventory.reservation.hold_expired","inventory.reservation.released","inventory.shortage.detected","inventory.transfer.closed","inventory.transfer.departed","inventory.transfer.lost","inventory.transfer.received","inventory.transfer.returned","invoice.collection_block_resolved","invoice.collection_blocked","invoice.created","invoice.credited","invoice.delivery_failed","invoice.delivery_succeeded","invoice.issue_failed","invoice.issued","invoice.late_fee_assessed","invoice.late_fee_due","invoice.late_fee_waived","invoice.manual_payment_recorded","invoice.manual_payment_reversed","invoice.marked_uncollectible","invoice.overdue","invoice.paid","invoice.partially_paid","invoice.partially_refunded","invoice.payment_attempt_canceled","invoice.payment_attempt_expired","invoice.payment_failed","invoice.payment_processing","invoice.refunded","invoice.reminder_due","invoice.sent","invoice.updated","invoice.voided","merchant.readiness.updated","merchant_billing_balance.updated","merchant_subscription_invoice.issued","merchant_subscription_invoice.updated","order.closed","order.created","order.fulfillment.completed","order.fulfillment.created","order.fulfillment.event.created","order.fulfillment.package.created","order.fulfillment.package.updated","order.fulfillment.shipment.created","order.fulfillment.shipment.updated","order.fulfillment.status_changed","order.fulfillment.updated","order.inventory_action_required","order.inventory_exception.created","order.inventory_exception.resolved","order.paid","order.partially_paid","order.payment_authorization_canceled","order.payment_authorization_expired","order.payment_authorized","order.payment_captured","order.refunded","order.updated","payment_intent.canceled","payment_intent.fulfillment_hold.updated","payment_intent.payment_failed","payment_intent.processing","payment_intent.requires_action","payment_intent.requires_capture","payment_intent.succeeded","payment_method.failed","payment_method.removed","payment_method.saved","payout.canceled","payout.created","payout.failed","payout.paid","payout.reversed","payout.updated","payout_destination.created","payout_destination.deleted","payout_destination.disabled","payout_destination.updated","payout_settings.updated","refund.created","refund.failed","refund.updated","report.failed","report.succeeded","return.canceled","return.completed","return.created","return.decision_recorded","return.reopened","return.updated","return_disposition.created","return_disposition.updated","return_inspection.acceptance_decided","return_inspection.created","return_inspection.superseded","return_receipt.created","return_receipt.superseded","return_receipt.verified","return_resolution.created","return_resolution.updated","review.closed","review.opened","subscription.activated","subscription.canceled","subscription.created","subscription.dunning_exhausted","subscription.past_due","subscription.paused","subscription.payment_failed","subscription.payment_succeeded","subscription.renewal_upcoming","subscription.resumed","subscription.trial_ending","subscription.updated"],"type":"string","x-enum-descriptions":["Balance.updated.","Balance transaction.created.","Balance transaction.updated.","Capability.updated.","Checkout session.closed.","Checkout session.completed.","Checkout session.expired.","Checkout session.invalidated.","Credit note.allocation created.","Credit note.allocation reversed.","Credit note.created.","Credit note.issued.","Credit note.updated.","Credit note.voided.","Customer.created.","Customer.deletion completed.","Customer.deletion rejected.","Customer.deletion requested.","Customer.updated.","Delivery location set.activated.","Delivery location set.archived.","Delivery location set.created.","Delivery location set.deactivated.","Delivery location set.updated.","Delivery method.activated.","Delivery method.archived.","Delivery method.created.","Delivery method.deactivated.","Delivery method.updated.","Delivery profile.activated.","Delivery profile.archived.","Delivery profile.created.","Delivery profile.deactivated.","Delivery profile.updated.","Delivery rate.archived.","Delivery rate.created.","Delivery rate.updated.","Delivery rate callback.activated.","Delivery rate callback.archived.","Delivery rate callback.created.","Delivery rate callback.deactivated.","Delivery rate callback.updated.","Delivery revocation.created.","Delivery selection.committed.","Delivery zone.activated.","Delivery zone.archived.","Delivery zone.created.","Delivery zone.deactivated.","Delivery zone.updated.","Dispute.closed.","Dispute.created.","Dispute.lost.","Dispute.needs response.","Dispute.prevented.","Dispute.updated.","Dispute.warning closed.","Dispute.won.","Fraud warning.created.","Fraud warning.updated.","Inventory.action required.","Inventory.count.applied.","Inventory.level.updated.","Inventory.receipt.created.","Inventory.reservation.at risk.","Inventory.reservation.closed.","Inventory.reservation.committed.","Inventory.reservation.consumed.","Inventory.reservation.created.","Inventory.reservation.hold expired.","Inventory.reservation.released.","Inventory.shortage.detected.","Inventory.transfer.closed.","Inventory.transfer.departed.","Inventory.transfer.lost.","Inventory.transfer.received.","Inventory.transfer.returned.","Invoice.collection block resolved.","Invoice.collection blocked.","Invoice.created.","Invoice.credited.","Invoice.delivery failed.","Invoice.delivery succeeded.","Invoice.issue failed.","Invoice.issued.","Invoice.late fee assessed.","Invoice.late fee due.","Invoice.late fee waived.","Invoice.manual payment recorded.","Invoice.manual payment reversed.","Invoice.marked uncollectible.","Invoice.overdue.","Invoice.paid.","Invoice.partially paid.","Invoice.partially refunded.","Invoice.payment attempt canceled.","Invoice.payment attempt expired.","Invoice.payment failed.","Invoice.payment processing.","Invoice.refunded.","Invoice.reminder due.","Invoice.sent.","Invoice.updated.","Invoice.voided.","Merchant.readiness.updated.","Merchant billing balance.updated.","Merchant subscription invoice.issued.","Merchant subscription invoice.updated.","Order.closed.","Order.created.","Order.fulfillment.completed.","Order.fulfillment.created.","Order.fulfillment.event.created.","Order.fulfillment.package.created.","Order.fulfillment.package.updated.","Order.fulfillment.shipment.created.","Order.fulfillment.shipment.updated.","Order.fulfillment.status changed.","Order.fulfillment.updated.","Order.inventory action required.","Order.inventory exception.created.","Order.inventory exception.resolved.","Order.paid.","Order.partially paid.","Order.payment authorization canceled.","Order.payment authorization expired.","Order.payment authorized.","Order.payment captured.","Order.refunded.","Order.updated.","Payment intent.canceled.","Payment intent.fulfillment hold.updated.","Payment intent.payment failed.","Payment intent.processing.","Payment intent.requires action.","Payment intent.requires capture.","Payment intent.succeeded.","Payment method.failed.","Payment method.removed.","Payment method.saved.","Payout.canceled.","Payout.created.","Payout.failed.","Payout.paid.","Payout.reversed.","Payout.updated.","Payout destination.created.","Payout destination.deleted.","Payout destination.disabled.","Payout destination.updated.","Payout settings.updated.","Refund.created.","Refund.failed.","Refund.updated.","Report.failed.","Report.succeeded.","Return.canceled.","Return.completed.","Return.created.","Return.decision recorded.","Return.reopened.","Return.updated.","Return disposition.created.","Return disposition.updated.","Return inspection.acceptance decided.","Return inspection.created.","Return inspection.superseded.","Return receipt.created.","Return receipt.superseded.","Return receipt.verified.","Return resolution.created.","Return resolution.updated.","Review.closed.","Review.opened.","Subscription.activated.","Subscription.canceled.","Subscription.created.","Subscription.dunning exhausted.","Subscription.past due.","Subscription.paused.","Subscription.payment failed.","Subscription.payment succeeded.","Subscription.renewal upcoming.","Subscription.resumed.","Subscription.trial ending.","Subscription.updated."],"x-flint-enum":"closed"}},{"description":"Webhook event ID to resume after. Last-Event-ID is preferred when reconnecting.","in":"query","name":"after_event_id","required":false,"schema":{"type":"string"}},{"description":"Webhook event cursor received from the previous SSE connection.","in":"header","name":"Last-Event-ID","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"text/event-stream":{"examples":{"visible":{"value":"id: whev_123\\nevent: webhook.event\\ndata: {\\\"webhook_event_id\\\":\\\"whev_123\\\"}\\n\\n"},"withheld":{"value":"id: whev_124\\nevent: withheld\\ndata: {\\\"webhook_event_id\\\":\\\"whev_124\\\",\\\"reason\\\":\\\"missing_resource_scope\\\"}\\n\\n"}},"schema":{"type":"string"},"x-flint-event-schemas":{"disconnect":{"$ref":"#/components/schemas/WebhookStreamDisconnect"},"gap":{"$ref":"#/components/schemas/WebhookStreamGap"},"ready":{"$ref":"#/components/schemas/WebhookStreamReady"},"webhook.event":{"$ref":"#/components/schemas/WebhookEvent"},"withheld":{"$ref":"#/components/schemas/WebhookStreamWithheld"}}}},"description":"An SSE stream of webhook.event, ready, gap, withheld, and disconnect records. Every cursor-advancing webhook.event, gap, or withheld record includes an id field suitable for Last-Event-ID.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"503":{"content":{"application/json":{"example":{"error":{"code":"WEBHOOK_STREAM_LIMITER_UNAVAILABLE","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"flint","message":"Webhook streaming is temporarily unavailable.","remediation":{"next_steps":"Retry with exponential backoff.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"unavailable_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Webhook streaming is temporarily unavailable.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Stream webhook events","tags":["webhooks"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","SERVICE_UNAVAILABLE","WEBHOOK_STREAM_LIMITER_UNAVAILABLE"],"x-flint-partner-access":"unsupported","x-flint-required-scopes":["webhooks.read","webhooks.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/webhook-events/{webhook_event_id}":{"get":{"description":"Returns a specific webhook event for the authenticated merchant.","operationId":"getWebhookEvent","parameters":[{"description":"Flint webhook event ID.","in":"path","name":"webhook_event_id","required":true,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":{"api_request_log_id":"rlog_123","correlation_id":"rlog_123","created_at":"2026-03-17T14:30:00Z","event_origin":"business_event","event_source":"merchant","event_type":"order.paid","payload":{"api_version":"2026-02-01","created_at":"2026-03-17T14:30:00Z","data":{"order_id":"ord_123","payment_status":"paid","status":"closed"},"event_type":"order.paid","merchant_id":"mer_123","mode":"live","payload_version":1,"webhook_event_id":"whev_123"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","resource_id":"ord_123","resource_type":"order","test":false,"webhook_event_id":"whev_123"},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/WebhookEventResponse"}}},"description":"The selected webhook event.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Webhook event not found.","param":"webhook_event_id","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Webhook event not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"Get webhook event","tags":["webhooks"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["webhooks.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["webhooks.read","webhooks.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}},"/v1/webhook-events/{webhook_event_id}/deliveries":{"get":{"description":"Returns endpoint deliveries created for one canonical webhook event.","operationId":"listWebhookDeliveries","parameters":[{"description":"Flint webhook event ID.","in":"path","name":"webhook_event_id","required":true,"schema":{"type":"string"}},{"description":"Page size, default 20, max 100.","in":"query","name":"page_size","required":false,"schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Cursor returned by the previous list response.","in":"query","name":"page_token","required":false,"schema":{"type":"string"}},{"description":"API version for this request. Overrides merchant and partner app defaults.","in":"header","name":"Flint-Version","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":{"data":[{"automatic_attempt_count":1,"created_at":"2026-03-17T14:30:00Z","delivered_at":"2026-03-17T14:30:02Z","last_response_code":200,"max_attempts":9,"status":"delivered","updated_at":"2026-03-17T14:30:02Z","webhook_delivery_id":"wdel_123","webhook_endpoint_id":"whep_123","webhook_event_id":"whev_123"}],"next_page_token":"Zm9yd2FyZC1vbmx5LW9wYXF1ZS1jdXJzb3I","request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6"},"schema":{"$ref":"#/components/schemas/WebhookDeliveryListResponse"}}},"description":"Webhook deliveries for the selected event.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"400":{"content":{"application/json":{"example":{"error":{"code":"INVALID_REQUEST","details":[{"code":"REQUIRED","message":"name is required","param":"line_items[0].name","remediation":{"next_steps":"Inspect the error response and request log detail, correct the request, then retry.","retryable":false}},{"code":"INVALID_AMOUNT","message":"amount must be greater than zero","param":"line_items[0].unit_price_money.amount","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false}}],"doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"One or more fields are invalid.","remediation":{"next_steps":"Fix the field identified by the error response, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"validation_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Invalid request.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"401":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authentication failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"403":{"content":{"application/json":{"example":{"error":{"code":"INVALID_API_KEY","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"The API key is invalid.","remediation":{"next_steps":"Check the API key value or create a new API key, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"authentication_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Authorization failed.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"404":{"content":{"application/json":{"example":{"error":{"code":"RESOURCE_NOT_FOUND","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Webhook event not found.","param":"webhook_event_id","remediation":{"next_steps":"Check the resource ID, mode, and merchant context, then retry.","retryable":false},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"not_found_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Webhook event not found.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}},"429":{"content":{"application/json":{"example":{"error":{"code":"RATE_LIMIT_EXCEEDED","doc_url":"https://developers.withflintpay.com/docs/errors","error_source":"merchant","message":"Rate limit exceeded.","remediation":{"next_steps":"Retry with exponential backoff and jitter. Use the Retry-After header when present.","retryable":true},"request_id":"bce56cba-0827-44aa-bb56-4f200ba15ee6","request_log_url":"/v1/developer/request-logs?request_id=bce56cba-0827-44aa-bb56-4f200ba15ee6","type":"rate_limit_error"}},"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Rate limit exceeded.","headers":{"Flint-Merchant-Environment-Id":{"description":"Flint merchant environment ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Merchant-Id":{"description":"Flint merchant ID for the authenticated request context.","schema":{"type":"string"}},"Flint-Mode":{"description":"Payment mode for the authenticated request context.","schema":{"enum":["test","live"],"type":"string","x-enum-descriptions":["Test.","Live."],"x-flint-enum":"closed"}},"Flint-Rate-Limited-Reason":{"description":"Stable Flint reason for the rate-limit decision.","schema":{"enum":["global-ip","api-key","merchant","setup-flow","demo-session","resource","feedback-intake"],"type":"string","x-enum-descriptions":["Global-ip.","Api-key.","Merchant.","Setup-flow.","Demo-session.","Resource.","Feedback-intake."],"x-flint-enum":"closed"}},"Flint-Sandbox-Id":{"description":"Flint sandbox ID for authenticated test-mode requests when the request is sandbox-bound.","schema":{"type":"string"}},"Flint-Version":{"description":"API version used to encode this response. A replay can be served at an older version than requested.","schema":{"format":"date","type":"string"}},"Retry-After":{"description":"Seconds to wait before retrying when Flint can calculate a retry time.","schema":{"pattern":"^[0-9]+$","type":"string"}},"X-Request-Id":{"description":"Request ID for tracing. Echoes the caller-supplied X-Request-Id when provided; otherwise generated by Flint.","schema":{"type":"string"}}}}},"security":[{"ApiKeyHeader":[]},{"BearerAuth":[]}],"summary":"List webhook deliveries","tags":["webhooks"],"x-flint-error-codes":["AUTH_REQUIRED","INSUFFICIENT_SCOPE","INVALID_API_KEY","INVALID_REQUEST","RATE_LIMIT_EXCEEDED","RESOURCE_NOT_FOUND"],"x-flint-partner-access":"install_scoped","x-flint-partner-required-scopes":["webhooks.read"],"x-flint-partner-required-scopes-mode":"any","x-flint-required-scopes":["webhooks.read","webhooks.write"],"x-flint-required-scopes-mode":"any","x-flint-route-class":"read"}}},"servers":[{"description":"Production API.","url":"https://api.withflintpay.com"},{"description":"Staging API for sandbox testing.","url":"https://api.staging.withflintpay.com"}],"tags":[{"description":"Analytics and reporting.","name":"analytics"},{"description":"API key management.","name":"api_keys"},{"description":"Product bundles.","name":"bundles"},{"description":"Merchant payment and money movement capability readiness.","name":"capabilities"},{"description":"Reusable product and bundle categories.","name":"categories"},{"description":"Checkout sessions and buyer-facing checkout delivery options.","name":"checkout_sessions"},{"description":"Browser-approved CLI sessions using OAuth device authorization, rotating refresh tokens, and grant revocation.","name":"cli_oauth"},{"description":"Correct an issued invoice without moving money. A credit note credits specific invoice lines, and allocating it draws down the invoice balance.","name":"credit_notes"},{"description":"Customer-session endpoints for a customer to manage their own account and commerce data.","name":"customer_account"},{"description":"Server-side customer-scoped credentials for merchant-hosted and Flint-hosted customer accounts.","name":"customer_sessions"},{"description":"Customers.","name":"customers"},{"description":"Versioned delivery profiles, methods, geographic zones, location sets, and rate callbacks.","name":"delivery_configuration"},{"description":"Exact display-only delivery evaluation without checkout creation or selection authority.","name":"delivery_previews"},{"description":"Persisted checkout delivery evaluations and merchant diagnostics.","name":"delivery_quotes"},{"description":"Permanent emergency fences for compromised or unsafe delivery dependencies.","name":"delivery_revocations"},{"description":"Immutable buyer-selected delivery economics and lifecycle history.","name":"delivery_selections"},{"description":"Demo and test-drive sessions.","name":"demo_sessions"},{"description":"Developer request logs and diagnostics.","name":"developer_logs"},{"description":"Point-of-sale and terminal devices.","name":"devices"},{"description":"Payment disputes.","name":"disputes"},{"description":"Feedback submitted about Flint-owned products and developer tools.","name":"feedback_reports"},{"description":"Fulfillments, shipments, packages, and their unified timelines.","name":"fulfillment"},{"description":"Location-aware inventory, allocation policies, routing, and reservations.","name":"inventory"},{"description":"Invoices and invoice payments.","name":"invoices"},{"description":"Environment-scoped merchant Locations and their geography and inventory capabilities.","name":"locations"},{"description":"Merchant account session launch surfaces.","name":"merchant_account_sessions"},{"description":"Current Flint merchant billing balances and subscription invoices.","name":"merchant_billing"},{"description":"Merchant profile and account data.","name":"merchants"},{"description":"API metadata.","name":"meta"},{"description":"Catalog modifiers and modifier sets.","name":"modifiers"},{"description":"Balances, payouts, payout settings, and money movement capabilities.","name":"money_movement"},{"description":"Merchant onboarding and document collection.","name":"onboarding"},{"description":"Orders, line items, payments, and related actions.","name":"orders"},{"description":"Organizations, memberships, and roles.","name":"organizations"},{"description":"Partner app registration and install management.","name":"partner_apps"},{"description":"Partner OAuth authorization and token exchange.","name":"partner_oauth"},{"description":"Payment intents and payment collection.","name":"payment_intents"},{"description":"Payment links.","name":"payment_links"},{"description":"Apple Pay and Google Pay domain registrations.","name":"payment_method_domains"},{"description":"Saved payment methods.","name":"payment_methods"},{"description":"Products and variants.","name":"products"},{"description":"Reusable automatic and code-gated discounts with eligibility and stacking rules.","name":"promotions"},{"description":"Refunds.","name":"refunds"},{"description":"Asynchronous merchant reports and authenticated CSV downloads.","name":"reports"},{"description":"Return receipts, inspections, and merchandise dispositions.","name":"return_operations"},{"description":"Versioned Return eligibility and automation policies.","name":"return_policies"},{"description":"Buyer and merchant Return reason vocabulary.","name":"return_reasons"},{"description":"Return refunds, exchanges, replacements, and linked effects.","name":"return_resolutions"},{"description":"Customer Return requests, decisions, progress, and completion.","name":"returns"},{"description":"Risk assessments, reviews, rules, lists, and fraud warnings.","name":"risk"},{"description":"Developer sandboxes and sandbox-bound test keys.","name":"sandboxes"},{"description":"Merchant settings.","name":"settings"},{"description":"Subscription plans.","name":"subscription_plans"},{"description":"Subscriptions.","name":"subscriptions"},{"description":"Webhook endpoints, events, deliveries, and test events.","name":"webhooks"}],"webhooks":{"balance.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_balance_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"balance_id":"bal_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"updated"},"event_type":"balance.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_balance_updated_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"The merchant's available or pending balance changed."}},"balance_transaction.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_balance_transaction_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"amount_money":{"amount":5000,"currency":"USD"},"balance_transaction_id":"btxn_123","currency":"USD","fee_money":{"amount":-175,"currency":"USD"},"merchant_id":"mer_123","net_money":{"amount":4825,"currency":"USD"},"occurred_at":"2026-07-03T14:30:00Z","status":"available","type":"payment"},"event_type":"balance_transaction.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_balance_transaction_created_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A new balance transaction (charge, refund, dispute, payout, fee, Flint billing collection, or adjustment) was recorded."}},"balance_transaction.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_balance_transaction_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"amount_money":{"amount":5000,"currency":"USD"},"available_at":"2026-03-19T00:00:00Z","balance_transaction_id":"btxn_123","currency":"USD","fee_money":{"amount":175,"currency":"USD"},"merchant_id":"mer_123","net_money":{"amount":4825,"currency":"USD"},"occurred_at":"2026-03-17T14:30:00Z","related_resource":{"payment_intent_id":"pi_123","type":"payment_intent"},"status":"available","type":"payment"},"event_type":"balance_transaction.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_balance_transaction_updated_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A balance transaction changed state."}},"capability.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_capability_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"capability":"card_payments","resource_updated_at":"2026-07-03T14:30:00Z","status":"updated"},"event_type":"capability.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_capability_updated_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A merchant capability (such as card payments or payouts) changed status."}},"checkout_session.closed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_checkout_session_closed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"checkout_session_id":"cs_123","environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","reason":"api","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"closed"},"event_type":"checkout_session.closed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"checkout_session_id":"cs_123","reason":"api","resource_updated_at":"2026-07-03T14:30:00Z","status":"closed"},"event_type":"checkout_session.closed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_checkout_session_closed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_checkout_session_closed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A hosted checkout session was closed before payment completed."}},"checkout_session.completed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_checkout_session_completed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"checkout_session_id":"cs_123","environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"completed"},"event_type":"checkout_session.completed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"checkout_session_id":"cs_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"completed"},"event_type":"checkout_session.completed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_checkout_session_completed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_checkout_session_completed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A hosted checkout session finished and its payment succeeded."}},"checkout_session.expired":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_checkout_session_expired","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"checkout_session_id":"cs_123","environment_grant_id":"egrt_123","expired_at":"2026-07-03T14:30:00Z","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","reason":"expired","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"expired"},"event_type":"checkout_session.expired","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"checkout_session_id":"cs_123","expired_at":"2026-07-03T14:30:00Z","reason":"expired","resource_updated_at":"2026-07-03T14:30:00Z","status":"expired"},"event_type":"checkout_session.expired","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_checkout_session_expired_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_checkout_session_expired_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A hosted checkout session expired."}},"checkout_session.invalidated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_checkout_session_invalidated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"checkout_session_id":"cs_123","environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","order_id":"ord_123","partner_app_install_id":"pinst_123","reason":"superseded","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"invalidated","superseding_checkout_session_id":"cs_456"},"event_type":"checkout_session.invalidated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"checkout_session_id":"cs_123","order_id":"ord_123","reason":"superseded","resource_updated_at":"2026-07-03T14:30:00Z","status":"invalidated","superseding_checkout_session_id":"cs_456"},"event_type":"checkout_session.invalidated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_checkout_session_invalidated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_checkout_session_invalidated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A hosted checkout session was invalidated because its source order, invoice, or payment link changed, or a replacement session superseded it."}},"credit_note.allocation_created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_credit_note_allocation_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"allocated_at":"2026-07-03T14:30:00Z","amount_money":{"amount":5000,"currency":"USD"},"credit_note_allocation_id":"cna_123","credit_note_id":"cn_123","environment_grant_id":"egrt_123","idempotency_key":"credit-allocation-test","invoice_id":"inv_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","source_type":"installed_merchants"},"event_type":"credit_note.allocation_created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"allocated_at":"2026-07-03T14:30:00Z","amount_money":{"amount":5000,"currency":"USD"},"credit_note_allocation_id":"cna_123","credit_note_id":"cn_123","idempotency_key":"credit-allocation-test","invoice_id":"inv_123"},"event_type":"credit_note.allocation_created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_credit_note_allocation_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_credit_note_allocation_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A credit note amount was allocated to its invoice."}},"credit_note.allocation_reversed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_credit_note_allocation_reversed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"allocated_at":"2026-07-03T14:30:00Z","amount_money":{"amount":5000,"currency":"USD"},"credit_note_allocation_id":"cna_123","credit_note_id":"cn_123","environment_grant_id":"egrt_123","idempotency_key":"credit-allocation-test","invoice_id":"inv_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","reversed_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"credit_note.allocation_reversed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"allocated_at":"2026-07-03T14:30:00Z","amount_money":{"amount":5000,"currency":"USD"},"credit_note_allocation_id":"cna_123","credit_note_id":"cn_123","idempotency_key":"credit-allocation-test","invoice_id":"inv_123","reversed_at":"2026-07-03T14:30:00Z"},"event_type":"credit_note.allocation_reversed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_credit_note_allocation_reversed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_credit_note_allocation_reversed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A credit note allocation was reversed."}},"credit_note.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_credit_note_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"created_at":"2026-07-03T14:30:00Z","credit_note_id":"cn_123","credit_note_lines":[],"environment_grant_id":"egrt_123","invoice_id":"inv_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","reason":"billing_error","source_type":"installed_merchants","status":"draft","total_money":{"amount":5000,"currency":"USD"},"unallocated_money":{"amount":5000,"currency":"USD"},"updated_at":"2026-07-03T14:30:00Z","version":1},"event_type":"credit_note.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"created_at":"2026-07-03T14:30:00Z","credit_note_id":"cn_123","credit_note_lines":[],"invoice_id":"inv_123","merchant_id":"mer_123","reason":"billing_error","status":"draft","total_money":{"amount":5000,"currency":"USD"},"unallocated_money":{"amount":5000,"currency":"USD"},"updated_at":"2026-07-03T14:30:00Z","version":1},"event_type":"credit_note.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_credit_note_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_credit_note_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A draft credit note was created."}},"credit_note.issued":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_credit_note_issued","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"created_at":"2026-07-03T14:30:00Z","credit_note_id":"cn_123","credit_note_lines":[],"credit_note_number":"CN-1001","environment_grant_id":"egrt_123","invoice_id":"inv_123","issued_at":"2026-07-03T14:30:00Z","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","reason":"billing_error","source_type":"installed_merchants","status":"issued","total_money":{"amount":5000,"currency":"USD"},"unallocated_money":{"amount":5000,"currency":"USD"},"updated_at":"2026-07-03T14:30:00Z","version":1},"event_type":"credit_note.issued","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"created_at":"2026-07-03T14:30:00Z","credit_note_id":"cn_123","credit_note_lines":[],"credit_note_number":"CN-1001","invoice_id":"inv_123","issued_at":"2026-07-03T14:30:00Z","merchant_id":"mer_123","reason":"billing_error","status":"issued","total_money":{"amount":5000,"currency":"USD"},"unallocated_money":{"amount":5000,"currency":"USD"},"updated_at":"2026-07-03T14:30:00Z","version":1},"event_type":"credit_note.issued","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_credit_note_issued_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_credit_note_issued_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A credit note was issued."}},"credit_note.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_credit_note_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"created_at":"2026-07-03T14:30:00Z","credit_note_id":"cn_123","credit_note_lines":[],"environment_grant_id":"egrt_123","invoice_id":"inv_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","reason":"billing_error","source_type":"installed_merchants","status":"draft","total_money":{"amount":5000,"currency":"USD"},"unallocated_money":{"amount":5000,"currency":"USD"},"updated_at":"2026-07-03T14:30:00Z","version":1},"event_type":"credit_note.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"created_at":"2026-07-03T14:30:00Z","credit_note_id":"cn_123","credit_note_lines":[],"invoice_id":"inv_123","merchant_id":"mer_123","reason":"billing_error","status":"draft","total_money":{"amount":5000,"currency":"USD"},"unallocated_money":{"amount":5000,"currency":"USD"},"updated_at":"2026-07-03T14:30:00Z","version":1},"event_type":"credit_note.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_credit_note_updated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_credit_note_updated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A draft credit note was updated."}},"credit_note.voided":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_credit_note_voided","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"created_at":"2026-07-03T14:30:00Z","credit_note_id":"cn_123","credit_note_lines":[],"credit_note_number":"CN-1001","environment_grant_id":"egrt_123","invoice_id":"inv_123","issued_at":"2026-07-03T14:30:00Z","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","reason":"billing_error","source_type":"installed_merchants","status":"void","total_money":{"amount":5000,"currency":"USD"},"unallocated_money":{"amount":5000,"currency":"USD"},"updated_at":"2026-07-03T14:30:00Z","version":1,"voided_at":"2026-07-03T14:30:00Z"},"event_type":"credit_note.voided","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"created_at":"2026-07-03T14:30:00Z","credit_note_id":"cn_123","credit_note_lines":[],"credit_note_number":"CN-1001","invoice_id":"inv_123","issued_at":"2026-07-03T14:30:00Z","merchant_id":"mer_123","reason":"billing_error","status":"void","total_money":{"amount":5000,"currency":"USD"},"unallocated_money":{"amount":5000,"currency":"USD"},"updated_at":"2026-07-03T14:30:00Z","version":1,"voided_at":"2026-07-03T14:30:00Z"},"event_type":"credit_note.voided","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_credit_note_voided_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_credit_note_voided_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A credit note was voided."}},"customer.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_customer_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"customer_id":"cus_123","environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"created"},"event_type":"customer.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"customer_id":"cus_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"created"},"event_type":"customer.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_customer_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_customer_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A customer record was created."}},"customer.deletion_completed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_customer_deletion_completed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"customer_deletion_request_id":"cdel_123","customer_id":"cus_123","environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","requested_at":"2026-07-03T14:30:00Z","resolved_at":"2026-07-04T09:15:00Z","retention_policy":"retain_required_commerce_records","source_type":"installed_merchants","status":"completed"},"event_type":"customer.deletion_completed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"customer_deletion_request_id":"cdel_123","customer_id":"cus_123","requested_at":"2026-07-03T14:30:00Z","resolved_at":"2026-07-04T09:15:00Z","retention_policy":"retain_required_commerce_records","status":"completed"},"event_type":"customer.deletion_completed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_customer_deletion_completed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_customer_deletion_completed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A customer deletion request completed and the customer was anonymized."}},"customer.deletion_rejected":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_customer_deletion_rejected","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"customer_deletion_request_id":"cdel_123","customer_id":"cus_123","environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","requested_at":"2026-07-03T14:30:00Z","resolved_at":"2026-07-04T09:15:00Z","retention_policy":"retain_required_commerce_records","source_type":"installed_merchants","status":"rejected"},"event_type":"customer.deletion_rejected","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"customer_deletion_request_id":"cdel_123","customer_id":"cus_123","requested_at":"2026-07-03T14:30:00Z","resolved_at":"2026-07-04T09:15:00Z","retention_policy":"retain_required_commerce_records","status":"rejected"},"event_type":"customer.deletion_rejected","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_customer_deletion_rejected_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_customer_deletion_rejected_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A customer deletion request was rejected."}},"customer.deletion_requested":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_customer_deletion_requested","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"customer_deletion_request_id":"cdel_123","customer_id":"cus_123","environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","requested_at":"2026-07-03T14:30:00Z","retention_policy":"retain_required_commerce_records","source_type":"installed_merchants","status":"pending_review"},"event_type":"customer.deletion_requested","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"customer_deletion_request_id":"cdel_123","customer_id":"cus_123","requested_at":"2026-07-03T14:30:00Z","retention_policy":"retain_required_commerce_records","status":"pending_review"},"event_type":"customer.deletion_requested","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_customer_deletion_requested_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_customer_deletion_requested_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A buyer requested deletion of their customer account data."}},"customer.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_customer_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"customer_id":"cus_123","environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"updated"},"event_type":"customer.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"customer_id":"cus_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"updated"},"event_type":"customer.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_customer_updated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_customer_updated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A customer record was updated."}},"delivery_location_set.activated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_location_set_activated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_location_set.activated","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_location_set.activated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_location_set.activated","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_location_set.activated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_location_set_activated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_location_set_activated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery location set was activated."}},"delivery_location_set.archived":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_location_set_archived","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_location_set.archived","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_location_set.archived","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_location_set.archived","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_location_set.archived","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_location_set_archived_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_location_set_archived_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery location set was archived."}},"delivery_location_set.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_location_set_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_location_set.created","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_location_set.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_location_set.created","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_location_set.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_location_set_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_location_set_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery location set was created."}},"delivery_location_set.deactivated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_location_set_deactivated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_location_set.deactivated","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_location_set.deactivated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_location_set.deactivated","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_location_set.deactivated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_location_set_deactivated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_location_set_deactivated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery location set was deactivated."}},"delivery_location_set.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_location_set_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_location_set.updated","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_location_set.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_location_set.updated","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_location_set.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_location_set_updated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_location_set_updated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery location set configuration changed."}},"delivery_method.activated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_method_activated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_method.activated","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_method.activated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_method.activated","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_method.activated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_method_activated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_method_activated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery method was activated."}},"delivery_method.archived":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_method_archived","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_method.archived","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_method.archived","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_method.archived","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_method.archived","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_method_archived_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_method_archived_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery method was archived."}},"delivery_method.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_method_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_method.created","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_method.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_method.created","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_method.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_method_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_method_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery method was created."}},"delivery_method.deactivated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_method_deactivated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_method.deactivated","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_method.deactivated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_method.deactivated","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_method.deactivated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_method_deactivated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_method_deactivated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery method was deactivated."}},"delivery_method.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_method_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_method.updated","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_method.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_method.updated","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_method.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_method_updated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_method_updated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery method configuration changed."}},"delivery_profile.activated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_profile_activated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_profile.activated","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_profile.activated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_profile.activated","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_profile.activated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_profile_activated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_profile_activated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery profile was activated."}},"delivery_profile.archived":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_profile_archived","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_profile.archived","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_profile.archived","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_profile.archived","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_profile.archived","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_profile_archived_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_profile_archived_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery profile was archived."}},"delivery_profile.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_profile_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_profile.created","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_profile.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_profile.created","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_profile.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_profile_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_profile_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery profile was created."}},"delivery_profile.deactivated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_profile_deactivated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_profile.deactivated","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_profile.deactivated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_profile.deactivated","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_profile.deactivated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_profile_deactivated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_profile_deactivated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery profile was deactivated."}},"delivery_profile.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_profile_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_profile.updated","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_profile.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_profile.updated","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_profile.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_profile_updated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_profile_updated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery profile configuration changed."}},"delivery_rate.archived":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_rate_archived","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_rate.archived","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_rate.archived","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_rate.archived","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_rate.archived","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_rate_archived_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_rate_archived_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery rate was archived with its owning method revision."}},"delivery_rate.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_rate_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_rate.created","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_rate.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_rate.created","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_rate.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_rate_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_rate_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery rate was created and its owning method revision advanced."}},"delivery_rate.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_rate_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_rate.updated","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_rate.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_rate.updated","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_rate.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_rate_updated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_rate_updated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery rate changed and its owning method revision advanced."}},"delivery_rate_callback.activated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_rate_callback_activated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_rate_callback.activated","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_rate_callback.activated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_rate_callback.activated","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_rate_callback.activated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_rate_callback_activated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_rate_callback_activated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery rate callback was activated."}},"delivery_rate_callback.archived":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_rate_callback_archived","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_rate_callback.archived","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_rate_callback.archived","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_rate_callback.archived","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_rate_callback.archived","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_rate_callback_archived_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_rate_callback_archived_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery rate callback was archived."}},"delivery_rate_callback.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_rate_callback_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_rate_callback.created","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_rate_callback.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_rate_callback.created","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_rate_callback.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_rate_callback_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_rate_callback_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery rate callback was created."}},"delivery_rate_callback.deactivated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_rate_callback_deactivated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_rate_callback.deactivated","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_rate_callback.deactivated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_rate_callback.deactivated","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_rate_callback.deactivated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_rate_callback_deactivated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_rate_callback_deactivated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery rate callback was deactivated."}},"delivery_rate_callback.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_rate_callback_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_rate_callback.updated","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_rate_callback.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_rate_callback.updated","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_rate_callback.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_rate_callback_updated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_rate_callback_updated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery rate callback configuration changed."}},"delivery_revocation.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_revocation_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_revocation.created","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_revocation.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_revocation.created","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_revocation.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_revocation_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_revocation_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An emergency delivery dependency revocation was created with a safe estimated impact."}},"delivery_selection.committed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_selection_committed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_selection.committed","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_selection.committed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_selection.committed","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_selection.committed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_selection_committed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_selection_committed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery selection became the order's committed fulfillment economics."}},"delivery_zone.activated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_zone_activated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_zone.activated","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_zone.activated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_zone.activated","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_zone.activated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_zone_activated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_zone_activated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery zone was activated."}},"delivery_zone.archived":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_zone_archived","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_zone.archived","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_zone.archived","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_zone.archived","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_zone.archived","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_zone_archived_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_zone_archived_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery zone was archived."}},"delivery_zone.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_zone_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_zone.created","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_zone.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_zone.created","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_zone.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_zone_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_zone_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery zone was created."}},"delivery_zone.deactivated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_zone_deactivated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_zone.deactivated","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_zone.deactivated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_zone.deactivated","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_zone.deactivated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_zone_deactivated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_zone_deactivated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery zone was deactivated."}},"delivery_zone.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_delivery_zone_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"delivery_zone.updated","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"delivery_zone.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"delivery_zone.updated","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"delivery_zone.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_delivery_zone_updated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_delivery_zone_updated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A delivery zone expression changed."}},"dispute.closed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_dispute_closed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"dispute_id":"du_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"closed"},"event_type":"dispute.closed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_dispute_closed_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A dispute was closed without further merchant action."}},"dispute.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_dispute_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"dispute_id":"du_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"created"},"event_type":"dispute.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_dispute_created_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A payment dispute was opened."}},"dispute.lost":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_dispute_lost","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"dispute_id":"du_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"lost"},"event_type":"dispute.lost","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_dispute_lost_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A dispute was resolved against the merchant."}},"dispute.needs_response":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_dispute_needs_response","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"dispute_id":"du_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"needs_response"},"event_type":"dispute.needs_response","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_dispute_needs_response_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A dispute needs a merchant response."}},"dispute.prevented":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_dispute_prevented","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"dispute_id":"du_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"prevented"},"event_type":"dispute.prevented","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_dispute_prevented_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A dispute warning was resolved before becoming a dispute."}},"dispute.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_dispute_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"dispute_id":"du_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"updated"},"event_type":"dispute.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_dispute_updated_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A dispute changed status or details."}},"dispute.warning_closed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_dispute_warning_closed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"dispute_id":"du_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"warning_closed"},"event_type":"dispute.warning_closed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_dispute_warning_closed_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A dispute warning was closed."}},"dispute.won":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_dispute_won","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"dispute_id":"du_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"won"},"event_type":"dispute.won","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_dispute_won_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A dispute was resolved in favor of the merchant."}},"fraud_warning.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_fraud_warning_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"actionable":true,"created_at":"2026-07-03T14:30:00Z","dispute_id":null,"environment_grant_id":"egrt_123","fraud_type":"unauthorized_use_of_card","fraud_warning_id":"fw_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","payment_intent_id":"pi_123","payment_summary":{"amount_money":{"amount":12900,"currency":"USD"},"email":"buyer@example.com","last4":"4242","payment_method_brand":"visa"},"reported_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"fraud_warning.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"actionable":true,"created_at":"2026-07-03T14:30:00Z","dispute_id":null,"fraud_type":"unauthorized_use_of_card","fraud_warning_id":"fw_123","payment_intent_id":"pi_123","payment_summary":{"amount_money":{"amount":12900,"currency":"USD"},"email":"buyer@example.com","last4":"4242","payment_method_brand":"visa"},"reported_at":"2026-07-03T14:30:00Z"},"event_type":"fraud_warning.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_fraud_warning_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_fraud_warning_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An early fraud warning was reported for a payment."}},"fraud_warning.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_fraud_warning_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"actionable":true,"created_at":"2026-07-03T14:30:00Z","dispute_id":null,"environment_grant_id":"egrt_123","fraud_type":"unauthorized_use_of_card","fraud_warning_id":"fw_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","payment_intent_id":"pi_123","payment_summary":{"amount_money":{"amount":12900,"currency":"USD"},"email":"buyer@example.com","last4":"4242","payment_method_brand":"visa"},"reported_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"fraud_warning.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"actionable":true,"created_at":"2026-07-03T14:30:00Z","dispute_id":null,"fraud_type":"unauthorized_use_of_card","fraud_warning_id":"fw_123","payment_intent_id":"pi_123","payment_summary":{"amount_money":{"amount":12900,"currency":"USD"},"email":"buyer@example.com","last4":"4242","payment_method_brand":"visa"},"reported_at":"2026-07-03T14:30:00Z"},"event_type":"fraud_warning.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_fraud_warning_updated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_fraud_warning_updated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An early fraud warning changed actionability or dispute linkage."}},"inventory.action_required":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_inventory_action_required","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"inventory.action_required","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"inventory.action_required","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_inventory_action_required_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An inventory claim requires a safe merchant action before commerce can continue."}},"inventory.count.applied":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_inventory_count_applied","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"inventory.count.applied","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"inventory.count.applied","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_inventory_count_applied_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An inventory count was applied and its variances were committed to inventory."}},"inventory.level.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_inventory_level_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"inventory.level.updated","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"inventory.level.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_inventory_level_updated_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An inventory level revision advanced."}},"inventory.receipt.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_inventory_receipt_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"inventory.receipt.created","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"inventory.receipt.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_inventory_receipt_created_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"Stock was received into Inventory directly or through a typed Return disposition."}},"inventory.reservation.at_risk":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_inventory_reservation_at_risk","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"inventory.reservation.at_risk","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"inventory.reservation.at_risk","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_inventory_reservation_at_risk_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A held or committed inventory claim became insufficiently protected."}},"inventory.reservation.closed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_inventory_reservation_closed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"inventory.reservation.closed","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"inventory.reservation.closed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_inventory_reservation_closed_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An inventory reservation has no active held or committed quantity."}},"inventory.reservation.committed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_inventory_reservation_committed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"inventory.reservation.committed","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"inventory.reservation.committed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_inventory_reservation_committed_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"Held inventory quantity became committed order inventory."}},"inventory.reservation.consumed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_inventory_reservation_consumed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"inventory.reservation.consumed","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"inventory.reservation.consumed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_inventory_reservation_consumed_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"Fulfillment consumed committed physical inventory."}},"inventory.reservation.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_inventory_reservation_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"inventory.reservation.created","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"inventory.reservation.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_inventory_reservation_created_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An inventory reservation was created with exact location assignments."}},"inventory.reservation.hold_expired":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_inventory_reservation_hold_expired","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"inventory.reservation.hold_expired","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"inventory.reservation.hold_expired","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_inventory_reservation_hold_expired_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A merchant-owned inventory hold reached its deadline."}},"inventory.reservation.released":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_inventory_reservation_released","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"inventory.reservation.released","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"inventory.reservation.released","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_inventory_reservation_released_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"Held or committed inventory quantity was released."}},"inventory.shortage.detected":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_inventory_shortage_detected","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"inventory.shortage.detected","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"inventory.shortage.detected","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_inventory_shortage_detected_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An inventory level has more protected claims than sellable physical stock."}},"inventory.transfer.closed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_inventory_transfer_closed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"inventory.transfer.closed","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"inventory.transfer.closed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_inventory_transfer_closed_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An inventory transfer reached a terminal state."}},"inventory.transfer.departed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_inventory_transfer_departed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"inventory.transfer.departed","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"inventory.transfer.departed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_inventory_transfer_departed_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"Inventory departed a transfer's origin."}},"inventory.transfer.lost":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_inventory_transfer_lost","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"inventory.transfer.lost","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"inventory.transfer.lost","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_inventory_transfer_lost_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"Inventory in transit was recorded as lost."}},"inventory.transfer.received":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_inventory_transfer_received","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"inventory.transfer.received","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"inventory.transfer.received","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_inventory_transfer_received_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"Inventory was received at a transfer's destination."}},"inventory.transfer.returned":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_inventory_transfer_returned","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"inventory.transfer.returned","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"inventory.transfer.returned","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_inventory_transfer_returned_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"Inventory in transit was returned to its origin."}},"invoice.collection_block_resolved":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_collection_block_resolved","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"collection_block_reason":"inventory_restored","collection_block_status":"resolved","collection_block_updated_at":"2026-07-03T14:30:00Z","environment_grant_id":"egrt_123","invoice_id":"inv_123","invoice_number":"1001","merchant_id":"mer_123","mode":"test","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"partner_app_install_id":"pinst_123","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"open","subscription_id":"sub_123","version":1},"event_type":"invoice.collection_block_resolved","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"collection_block_reason":"inventory_restored","collection_block_status":"resolved","collection_block_updated_at":"2026-07-03T14:30:00Z","invoice_id":"inv_123","invoice_number":"1001","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"open","subscription_id":"sub_123","version":1},"event_type":"invoice.collection_block_resolved","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_collection_block_resolved_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_collection_block_resolved_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An invoice collection block was resolved and the invoice can be collected again."}},"invoice.collection_blocked":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_collection_blocked","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"collection_block_reason":"inventory_unavailable","collection_block_status":"inventory_blocked","collection_block_updated_at":"2026-07-03T14:30:00Z","environment_grant_id":"egrt_123","invoice_id":"inv_123","invoice_number":"1001","merchant_id":"mer_123","mode":"test","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"partner_app_install_id":"pinst_123","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"open","subscription_id":"sub_123","version":1},"event_type":"invoice.collection_blocked","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"collection_block_reason":"inventory_unavailable","collection_block_status":"inventory_blocked","collection_block_updated_at":"2026-07-03T14:30:00Z","invoice_id":"inv_123","invoice_number":"1001","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"open","subscription_id":"sub_123","version":1},"event_type":"invoice.collection_blocked","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_collection_blocked_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_collection_blocked_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"Invoice collection was blocked because a prerequisite such as inventory changed."}},"invoice.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","invoice_id":"inv_123","merchant_id":"mer_123","mode":"test","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"partner_app_install_id":"pinst_123","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"draft","version":1},"event_type":"invoice.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"invoice_id":"inv_123","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"draft","version":1},"event_type":"invoice.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An invoice was created."}},"invoice.credited":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_credited","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"closed_at":"2026-07-03T14:30:00Z","collection_mode":"buyer_initiated","credit_money":{"amount":5000,"currency":"USD"},"delivery_mode":"email","environment_grant_id":"egrt_123","invoice_id":"inv_123","invoice_number":"1001","issued_at":"2026-07-03T14:30:00Z","merchant_id":"mer_123","mode":"test","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"partner_app_install_id":"pinst_123","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"credited","version":1},"event_type":"invoice.credited","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"closed_at":"2026-07-03T14:30:00Z","collection_mode":"buyer_initiated","credit_money":{"amount":5000,"currency":"USD"},"delivery_mode":"email","invoice_id":"inv_123","invoice_number":"1001","issued_at":"2026-07-03T14:30:00Z","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"credited","version":1},"event_type":"invoice.credited","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_credited_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_credited_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"Credit note allocations closed an invoice with no remaining balance."}},"invoice.delivery_failed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_delivery_failed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","invoice_id":"inv_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","version":1},"event_type":"invoice.delivery_failed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"invoice_id":"inv_123","resource_updated_at":"2026-07-03T14:30:00Z","version":1},"event_type":"invoice.delivery_failed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_delivery_failed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_delivery_failed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An invoice email could not be delivered."}},"invoice.delivery_succeeded":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_delivery_succeeded","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","invoice_id":"inv_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","version":1},"event_type":"invoice.delivery_succeeded","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"invoice_id":"inv_123","resource_updated_at":"2026-07-03T14:30:00Z","version":1},"event_type":"invoice.delivery_succeeded","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_delivery_succeeded_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_delivery_succeeded_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An invoice email was delivered."}},"invoice.issue_failed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_issue_failed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","error_code":"RECIPIENT_EMAIL_REQUIRED","invoice_id":"inv_123","merchant_id":"mer_123","mode":"test","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"partner_app_install_id":"pinst_123","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"draft","version":1},"event_type":"invoice.issue_failed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"error_code":"RECIPIENT_EMAIL_REQUIRED","invoice_id":"inv_123","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"draft","version":1},"event_type":"invoice.issue_failed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_issue_failed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_issue_failed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A scheduled invoice could not be issued and remains a draft."}},"invoice.issued":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_issued","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"collection_mode":"buyer_initiated","delivery_mode":"email","environment_grant_id":"egrt_123","invoice_id":"inv_123","invoice_number":"1001","issued_at":"2026-07-03T14:30:00Z","merchant_id":"mer_123","mode":"test","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"partner_app_install_id":"pinst_123","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"open","version":1},"event_type":"invoice.issued","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"collection_mode":"buyer_initiated","delivery_mode":"email","invoice_id":"inv_123","invoice_number":"1001","issued_at":"2026-07-03T14:30:00Z","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"open","version":1},"event_type":"invoice.issued","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_issued_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_issued_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An invoice was issued and became open for collection."}},"invoice.late_fee_assessed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_late_fee_assessed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"amount_money":{"amount":250,"currency":"USD"},"collection_mode":"buyer_initiated","delivery_mode":"email","environment_grant_id":"egrt_123","invoice_id":"inv_123","invoice_late_fee_id":"inlf_01J00000000000000000000000","invoice_number":"1001","issued_at":"2026-07-03T14:30:00Z","merchant_id":"mer_123","mode":"test","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"partner_app_install_id":"pinst_123","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"open","version":1},"event_type":"invoice.late_fee_assessed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"amount_money":{"amount":250,"currency":"USD"},"collection_mode":"buyer_initiated","delivery_mode":"email","invoice_id":"inv_123","invoice_late_fee_id":"inlf_01J00000000000000000000000","invoice_number":"1001","issued_at":"2026-07-03T14:30:00Z","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"open","version":1},"event_type":"invoice.late_fee_assessed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_late_fee_assessed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_late_fee_assessed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A late fee was added to an invoice balance."}},"invoice.late_fee_due":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_late_fee_due","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"base_outstanding_money":{"amount":5000,"currency":"USD"},"collection_mode":"buyer_initiated","delivery_mode":"email","due_at":"2026-07-03T14:30:00Z","environment_grant_id":"egrt_123","invoice_id":"inv_123","invoice_number":"1001","issued_at":"2026-07-03T14:30:00Z","late_fee_money":{"amount":250,"currency":"USD"},"late_fee_policy":{"grace_period_days":5,"percent":5,"type":"percentage"},"merchant_id":"mer_123","mode":"test","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"partner_app_install_id":"pinst_123","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"open","version":1},"event_type":"invoice.late_fee_due","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"base_outstanding_money":{"amount":5000,"currency":"USD"},"collection_mode":"buyer_initiated","delivery_mode":"email","due_at":"2026-07-03T14:30:00Z","invoice_id":"inv_123","invoice_number":"1001","issued_at":"2026-07-03T14:30:00Z","late_fee_money":{"amount":250,"currency":"USD"},"late_fee_policy":{"grace_period_days":5,"percent":5,"type":"percentage"},"order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"open","version":1},"event_type":"invoice.late_fee_due","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_late_fee_due_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_late_fee_due_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An invoice reached a configured late fee date."}},"invoice.late_fee_waived":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_late_fee_waived","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"amount_money":{"amount":250,"currency":"USD"},"collection_mode":"buyer_initiated","delivery_mode":"email","environment_grant_id":"egrt_123","invoice_id":"inv_123","invoice_late_fee_id":"inlf_01J00000000000000000000000","invoice_number":"1001","issued_at":"2026-07-03T14:30:00Z","merchant_id":"mer_123","mode":"test","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"partner_app_install_id":"pinst_123","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"open","version":1},"event_type":"invoice.late_fee_waived","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"amount_money":{"amount":250,"currency":"USD"},"collection_mode":"buyer_initiated","delivery_mode":"email","invoice_id":"inv_123","invoice_late_fee_id":"inlf_01J00000000000000000000000","invoice_number":"1001","issued_at":"2026-07-03T14:30:00Z","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"open","version":1},"event_type":"invoice.late_fee_waived","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_late_fee_waived_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_late_fee_waived_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"The unpaid remainder of an invoice late fee was waived."}},"invoice.manual_payment_recorded":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_manual_payment_recorded","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","invoice_id":"inv_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","version":1},"event_type":"invoice.manual_payment_recorded","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"invoice_id":"inv_123","resource_updated_at":"2026-07-03T14:30:00Z","version":1},"event_type":"invoice.manual_payment_recorded","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_manual_payment_recorded_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_manual_payment_recorded_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A manual (offline) payment was recorded against an invoice."}},"invoice.manual_payment_reversed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_manual_payment_reversed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","invoice_id":"inv_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","version":1},"event_type":"invoice.manual_payment_reversed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"invoice_id":"inv_123","resource_updated_at":"2026-07-03T14:30:00Z","version":1},"event_type":"invoice.manual_payment_reversed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_manual_payment_reversed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_manual_payment_reversed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A previously recorded manual payment was reversed."}},"invoice.marked_uncollectible":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_marked_uncollectible","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"collection_mode":"buyer_initiated","delivery_mode":"email","environment_grant_id":"egrt_123","invoice_id":"inv_123","invoice_number":"1001","issued_at":"2026-07-03T14:30:00Z","merchant_id":"mer_123","mode":"test","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"partner_app_install_id":"pinst_123","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"uncollectible","uncollectible_at":"2026-07-03T14:30:00Z","version":1,"written_off_money":{"amount":5000,"currency":"USD"}},"event_type":"invoice.marked_uncollectible","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"collection_mode":"buyer_initiated","delivery_mode":"email","invoice_id":"inv_123","invoice_number":"1001","issued_at":"2026-07-03T14:30:00Z","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"uncollectible","uncollectible_at":"2026-07-03T14:30:00Z","version":1,"written_off_money":{"amount":5000,"currency":"USD"}},"event_type":"invoice.marked_uncollectible","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_marked_uncollectible_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_marked_uncollectible_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An invoice's outstanding balance was written off as uncollectible."}},"invoice.overdue":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_overdue","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"collection_mode":"buyer_initiated","delivery_mode":"email","due_at":"2026-07-03T14:30:00Z","environment_grant_id":"egrt_123","invoice_id":"inv_123","invoice_number":"1001","issued_at":"2026-07-03T14:30:00Z","merchant_id":"mer_123","mode":"test","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"partner_app_install_id":"pinst_123","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"open","version":1},"event_type":"invoice.overdue","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"collection_mode":"buyer_initiated","delivery_mode":"email","due_at":"2026-07-03T14:30:00Z","invoice_id":"inv_123","invoice_number":"1001","issued_at":"2026-07-03T14:30:00Z","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"open","version":1},"event_type":"invoice.overdue","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_overdue_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_overdue_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An invoice passed its payment due date with an outstanding balance."}},"invoice.paid":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_paid","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","invoice_id":"inv_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"paid","version":1},"event_type":"invoice.paid","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"invoice_id":"inv_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"paid","version":1},"event_type":"invoice.paid","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_paid_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_paid_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An invoice was paid in full."}},"invoice.partially_paid":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_partially_paid","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","invoice_id":"inv_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","version":1},"event_type":"invoice.partially_paid","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"invoice_id":"inv_123","resource_updated_at":"2026-07-03T14:30:00Z","version":1},"event_type":"invoice.partially_paid","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_partially_paid_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_partially_paid_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An invoice received a partial payment."}},"invoice.partially_refunded":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_partially_refunded","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","invoice_id":"inv_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","version":1},"event_type":"invoice.partially_refunded","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"invoice_id":"inv_123","resource_updated_at":"2026-07-03T14:30:00Z","version":1},"event_type":"invoice.partially_refunded","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_partially_refunded_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_partially_refunded_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"Part of an invoice's payment was refunded."}},"invoice.payment_attempt_canceled":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_payment_attempt_canceled","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"checkout_session_id":"cs_123","environment_grant_id":"egrt_123","expected_amount_money":{"amount":5000,"currency":"USD"},"invoice_id":"inv_123","invoice_number":"1001","invoice_payment_attempt_id":"invpa_123","merchant_id":"mer_123","mode":"test","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"partner_app_install_id":"pinst_123","payment_attempt_status":"canceled","payment_attempt_updated_at":"2026-07-03T14:30:00Z","payment_rail":"card","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"open","version":1},"event_type":"invoice.payment_attempt_canceled","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"checkout_session_id":"cs_123","expected_amount_money":{"amount":5000,"currency":"USD"},"invoice_id":"inv_123","invoice_number":"1001","invoice_payment_attempt_id":"invpa_123","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"payment_attempt_status":"canceled","payment_attempt_updated_at":"2026-07-03T14:30:00Z","payment_rail":"card","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"open","version":1},"event_type":"invoice.payment_attempt_canceled","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_payment_attempt_canceled_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_payment_attempt_canceled_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An invoice payment attempt was canceled."}},"invoice.payment_attempt_expired":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_payment_attempt_expired","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","expected_amount_money":{"amount":5000,"currency":"USD"},"invoice_id":"inv_123","invoice_number":"1001","invoice_payment_attempt_id":"invpa_123","merchant_id":"mer_123","mode":"test","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"partner_app_install_id":"pinst_123","payment_attempt_expires_at":"2026-07-03T14:30:00Z","payment_attempt_status":"expired","payment_attempt_updated_at":"2026-07-03T14:30:00Z","payment_rail":"card","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"open","version":1},"event_type":"invoice.payment_attempt_expired","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"expected_amount_money":{"amount":5000,"currency":"USD"},"invoice_id":"inv_123","invoice_number":"1001","invoice_payment_attempt_id":"invpa_123","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"payment_attempt_expires_at":"2026-07-03T14:30:00Z","payment_attempt_status":"expired","payment_attempt_updated_at":"2026-07-03T14:30:00Z","payment_rail":"card","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"open","version":1},"event_type":"invoice.payment_attempt_expired","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_payment_attempt_expired_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_payment_attempt_expired_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An invoice payment attempt expired."}},"invoice.payment_failed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_payment_failed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","expected_amount_money":{"amount":5000,"currency":"USD"},"failure_code":"insufficient_funds","failure_message":"The card has insufficient funds.","invoice_id":"inv_123","invoice_number":"1001","invoice_payment_attempt_id":"invpa_123","merchant_id":"mer_123","mode":"test","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"partner_app_install_id":"pinst_123","payment_attempt_status":"failed","payment_attempt_updated_at":"2026-07-03T14:30:00Z","payment_intent_id":"pi_123","payment_rail":"card","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"open","version":1},"event_type":"invoice.payment_failed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"expected_amount_money":{"amount":5000,"currency":"USD"},"failure_code":"insufficient_funds","failure_message":"The card has insufficient funds.","invoice_id":"inv_123","invoice_number":"1001","invoice_payment_attempt_id":"invpa_123","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"payment_attempt_status":"failed","payment_attempt_updated_at":"2026-07-03T14:30:00Z","payment_intent_id":"pi_123","payment_rail":"card","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"open","version":1},"event_type":"invoice.payment_failed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_payment_failed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_payment_failed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An invoice payment attempt failed."}},"invoice.payment_processing":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_payment_processing","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","expected_amount_money":{"amount":5000,"currency":"USD"},"expected_settlement_at":"2026-07-08T14:30:00Z","invoice_id":"inv_123","invoice_number":"1001","invoice_payment_attempt_id":"invpa_123","merchant_id":"mer_123","mode":"test","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"partner_app_install_id":"pinst_123","payment_attempt_status":"processing","payment_attempt_updated_at":"2026-07-03T14:30:00Z","payment_intent_id":"pi_123","payment_rail":"ach_debit","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"open","version":1},"event_type":"invoice.payment_processing","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"expected_amount_money":{"amount":5000,"currency":"USD"},"expected_settlement_at":"2026-07-08T14:30:00Z","invoice_id":"inv_123","invoice_number":"1001","invoice_payment_attempt_id":"invpa_123","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"payment_attempt_status":"processing","payment_attempt_updated_at":"2026-07-03T14:30:00Z","payment_intent_id":"pi_123","payment_rail":"ach_debit","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"open","version":1},"event_type":"invoice.payment_processing","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_payment_processing_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_payment_processing_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An invoice payment attempt entered processing."}},"invoice.refunded":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_refunded","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","invoice_id":"inv_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"refunded","version":1},"event_type":"invoice.refunded","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"invoice_id":"inv_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"refunded","version":1},"event_type":"invoice.refunded","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_refunded_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_refunded_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An invoice's payment was fully refunded."}},"invoice.reminder_due":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_reminder_due","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"collection_mode":"buyer_initiated","delivery_mode":"email","due_at":"2026-07-03T14:30:00Z","environment_grant_id":"egrt_123","invoice_id":"inv_123","invoice_number":"1001","issued_at":"2026-07-03T14:30:00Z","merchant_id":"mer_123","mode":"test","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"partner_app_install_id":"pinst_123","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"open","version":1},"event_type":"invoice.reminder_due","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"collection_mode":"buyer_initiated","delivery_mode":"email","due_at":"2026-07-03T14:30:00Z","invoice_id":"inv_123","invoice_number":"1001","issued_at":"2026-07-03T14:30:00Z","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"open","version":1},"event_type":"invoice.reminder_due","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_reminder_due_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_reminder_due_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An invoice reminder is ready to send."}},"invoice.sent":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_sent","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","invoice_id":"inv_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"sent","version":1},"event_type":"invoice.sent","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"invoice_id":"inv_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"sent","version":1},"event_type":"invoice.sent","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_sent_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_sent_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An invoice was sent to the customer."}},"invoice.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","invoice_id":"inv_123","invoice_number":"1001","merchant_id":"mer_123","mode":"test","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"partner_app_install_id":"pinst_123","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"draft","version":1},"event_type":"invoice.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"invoice_id":"inv_123","invoice_number":"1001","order_id":"ord_123","outstanding_money":{"amount":5000,"currency":"USD"},"refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"draft","version":1},"event_type":"invoice.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_updated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_updated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An invoice draft or scheduled send time was updated."}},"invoice.voided":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_invoice_voided","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","invoice_id":"inv_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"void","version":1},"event_type":"invoice.voided","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"invoice_id":"inv_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"void","version":1},"event_type":"invoice.voided","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_invoice_voided_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_invoice_voided_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An invoice was voided and can no longer be paid."}},"merchant.readiness.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_merchant_readiness_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"business_name":"Test Shop","merchant_environment_id":"menv_123","merchant_id":"mer_123","observed_at":"2026-07-03T14:30:00Z","payments":{"next_actions":[],"status":"ready","status_reason":null},"payouts":{"next_actions":[{"action_type":"create_merchant_account_session"}],"status":"blocked","status_reason":"requirements_due"},"requirements":{"current_deadline_at":"2026-07-03T14:30:00Z","currently_due":["business_website"],"disabled_reason":null,"eventually_due":[],"past_due":[],"pending_verification":[]}},"event_type":"merchant.readiness.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_merchant_readiness_updated_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A merchant's payment, payout, or onboarding readiness was observed in live or sandbox mode."}},"merchant_billing_balance.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_merchant_billing_balance_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"available_credit_money":{"amount":2500,"currency":"USD"},"merchant_billing_balance_id":"mbbal_123","observed_at":"2026-07-03T14:30:00Z","outstanding_money":{"amount":12500,"currency":"USD"}},"event_type":"merchant_billing_balance.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_merchant_billing_balance_updated_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"The amount the merchant owes Flint or owns as account credit changed."}},"merchant_subscription_invoice.issued":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_merchant_subscription_invoice_issued","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"created_at":"2026-07-03T14:30:00Z","credit_money":{"amount":0,"currency":"USD"},"due_at":"2026-07-03T14:30:00Z","invoice_number":"FLINT-1001","issued_at":"2026-07-03T14:30:00Z","lines":[],"merchant_subscription_invoice_id":"msi_123","outstanding_money":{"amount":1000,"currency":"USD"},"period_end":"2026-07-01","period_start":"2026-06-01","status":"open","subtotal_money":{"amount":1000,"currency":"USD"},"total_money":{"amount":1000,"currency":"USD"},"updated_at":"2026-07-03T14:30:00Z"},"event_type":"merchant_subscription_invoice.issued","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_merchant_subscription_invoice_issued_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A Flint merchant subscription invoice was issued."}},"merchant_subscription_invoice.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_merchant_subscription_invoice_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"created_at":"2026-07-03T14:30:00Z","credit_money":{"amount":0,"currency":"USD"},"due_at":"2026-07-03T14:30:00Z","invoice_number":"FLINT-1001","issued_at":"2026-07-03T14:30:00Z","lines":[],"merchant_subscription_invoice_id":"msi_123","outstanding_money":{"amount":1000,"currency":"USD"},"period_end":"2026-07-01","period_start":"2026-06-01","status":"open","subtotal_money":{"amount":1000,"currency":"USD"},"total_money":{"amount":1000,"currency":"USD"},"updated_at":"2026-07-03T14:30:00Z"},"event_type":"merchant_subscription_invoice.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_merchant_subscription_invoice_updated_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A Flint merchant subscription invoice changed collection status."}},"order.closed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_closed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","order_id":"ord_123","order_number":"1001","partner_app_install_id":"pinst_123","payment_status":"unpaid","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"closed"},"event_type":"order.closed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"order_id":"ord_123","order_number":"1001","payment_status":"unpaid","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"closed"},"event_type":"order.closed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_closed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_closed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An order was closed before being fully paid."}},"order.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"customer_id":"cus_123","environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","order_id":"ord_123","order_number":"1001","origin":"api","partner_app_install_id":"pinst_123","payment_status":"unpaid","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"open"},"event_type":"order.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"customer_id":"cus_123","order_id":"ord_123","order_number":"1001","origin":"api","payment_status":"unpaid","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"open"},"event_type":"order.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An order was created."}},"order.fulfillment.completed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_fulfillment_completed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","fulfillment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","resource_url":"/v1/fulfillments/ful_123","state":"completed","type":"shipment","updated_at":"2026-07-03T14:30:00Z"},"fulfillment_id":"ful_123","merchant_id":"mer_123","mode":"test","order":{"fulfillment_status":"partially_fulfilled","order_id":"ord_123","status":"open"},"order_id":"ord_123","partner_app_install_id":"pinst_123","source_type":"installed_merchants"},"event_type":"order.fulfillment.completed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"fulfillment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","resource_url":"/v1/fulfillments/ful_123","state":"completed","type":"shipment","updated_at":"2026-07-03T14:30:00Z"},"fulfillment_id":"ful_123","order":{"fulfillment_status":"partially_fulfilled","order_id":"ord_123","status":"open"},"order_id":"ord_123"},"event_type":"order.fulfillment.completed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_fulfillment_completed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_fulfillment_completed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A materialized order fulfillment completed all non-canceled obligated quantity."}},"order.fulfillment.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_fulfillment_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","fulfillment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","resource_url":"/v1/fulfillments/ful_123","state":"pending","type":"shipment","updated_at":"2026-07-03T14:30:00Z"},"fulfillment_id":"ful_123","merchant_id":"mer_123","mode":"test","order":{"fulfillment_status":"partially_fulfilled","order_id":"ord_123","status":"open"},"order_id":"ord_123","partner_app_install_id":"pinst_123","source_type":"installed_merchants"},"event_type":"order.fulfillment.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"fulfillment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","resource_url":"/v1/fulfillments/ful_123","state":"pending","type":"shipment","updated_at":"2026-07-03T14:30:00Z"},"fulfillment_id":"ful_123","order":{"fulfillment_status":"partially_fulfilled","order_id":"ord_123","status":"open"},"order_id":"ord_123"},"event_type":"order.fulfillment.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_fulfillment_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_fulfillment_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A committed fulfillment execution leg materialized as an order fulfillment."}},"order.fulfillment.event.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_fulfillment_event_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","fulfillment_event":{"buyer_notification_behavior":"default","event_type":"shipped","fulfillment_event_id":"fulev_123","fulfillment_id":"ful_123","occurred_at":"2026-07-03T14:30:00Z","order_id":"ord_123","received_at":"2026-07-03T14:30:00Z"},"fulfillment_event_id":"fulev_123","fulfillment_id":"ful_123","merchant_id":"mer_123","mode":"test","order_id":"ord_123","partner_app_install_id":"pinst_123","source_type":"installed_merchants"},"event_type":"order.fulfillment.event.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"fulfillment_event":{"buyer_notification_behavior":"default","event_type":"shipped","fulfillment_event_id":"fulev_123","fulfillment_id":"ful_123","occurred_at":"2026-07-03T14:30:00Z","order_id":"ord_123","received_at":"2026-07-03T14:30:00Z"},"fulfillment_event_id":"fulev_123","fulfillment_id":"ful_123","order_id":"ord_123"},"event_type":"order.fulfillment.event.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_fulfillment_event_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_fulfillment_event_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A fulfillment event was recorded from a carrier, pickup flow, appointment system, or other fulfillment source."}},"order.fulfillment.package.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_fulfillment_package_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","fulfillment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","resource_url":"/v1/fulfillments/ful_123","state":"in_progress","type":"shipment","updated_at":"2026-07-03T14:30:00Z"},"fulfillment_id":"ful_123","merchant_id":"mer_123","mode":"test","order":{"fulfillment_status":"partially_fulfilled","order_id":"ord_123","status":"open"},"order_id":"ord_123","package":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","package_id":"fulpkg_123","shipment_id":"fulsh_123","status":"created","updated_at":"2026-07-03T14:30:00Z"},"package_id":"fulpkg_123","partner_app_install_id":"pinst_123","shipment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","shipment_id":"fulsh_123","status":"created","updated_at":"2026-07-03T14:30:00Z"},"shipment_id":"fulsh_123","source_type":"installed_merchants"},"event_type":"order.fulfillment.package.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"fulfillment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","resource_url":"/v1/fulfillments/ful_123","state":"in_progress","type":"shipment","updated_at":"2026-07-03T14:30:00Z"},"fulfillment_id":"ful_123","order":{"fulfillment_status":"partially_fulfilled","order_id":"ord_123","status":"open"},"order_id":"ord_123","package":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","package_id":"fulpkg_123","shipment_id":"fulsh_123","status":"created","updated_at":"2026-07-03T14:30:00Z"},"package_id":"fulpkg_123","shipment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","shipment_id":"fulsh_123","status":"created","updated_at":"2026-07-03T14:30:00Z"},"shipment_id":"fulsh_123"},"event_type":"order.fulfillment.package.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_fulfillment_package_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_fulfillment_package_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A shipment package was created."}},"order.fulfillment.package.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_fulfillment_package_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"current_status":"shipped","environment_grant_id":"egrt_123","fulfillment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","resource_url":"/v1/fulfillments/ful_123","state":"in_progress","type":"shipment","updated_at":"2026-07-03T14:30:00Z"},"fulfillment_id":"ful_123","merchant_id":"mer_123","mode":"test","order":{"fulfillment_status":"partially_fulfilled","order_id":"ord_123","status":"open"},"order_id":"ord_123","package":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","package_id":"fulpkg_123","shipment_id":"fulsh_123","status":"shipped","updated_at":"2026-07-03T14:30:00Z"},"package_id":"fulpkg_123","package_status_update":{"buyer_notification_behavior":"default","created_at":"2026-07-03T14:30:00Z","current_status":"shipped","fulfillment_id":"ful_123","occurred_at":"2026-07-03T14:30:00Z","order_id":"ord_123","package_id":"fulpkg_123","package_status_update_id":"fulpkgsu_123","previous_status":"packed","shipment_id":"fulsh_123"},"package_status_update_id":"fulpkgsu_123","partner_app_install_id":"pinst_123","previous_status":"packed","shipment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","shipment_id":"fulsh_123","status":"created","updated_at":"2026-07-03T14:30:00Z"},"shipment_id":"fulsh_123","source_type":"installed_merchants"},"event_type":"order.fulfillment.package.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"current_status":"shipped","fulfillment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","resource_url":"/v1/fulfillments/ful_123","state":"in_progress","type":"shipment","updated_at":"2026-07-03T14:30:00Z"},"fulfillment_id":"ful_123","order":{"fulfillment_status":"partially_fulfilled","order_id":"ord_123","status":"open"},"order_id":"ord_123","package":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","package_id":"fulpkg_123","shipment_id":"fulsh_123","status":"shipped","updated_at":"2026-07-03T14:30:00Z"},"package_id":"fulpkg_123","package_status_update":{"buyer_notification_behavior":"default","created_at":"2026-07-03T14:30:00Z","current_status":"shipped","fulfillment_id":"ful_123","occurred_at":"2026-07-03T14:30:00Z","order_id":"ord_123","package_id":"fulpkg_123","package_status_update_id":"fulpkgsu_123","previous_status":"packed","shipment_id":"fulsh_123"},"package_status_update_id":"fulpkgsu_123","previous_status":"packed","shipment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","shipment_id":"fulsh_123","status":"created","updated_at":"2026-07-03T14:30:00Z"},"shipment_id":"fulsh_123"},"event_type":"order.fulfillment.package.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_fulfillment_package_updated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_fulfillment_package_updated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A shipment package status changed."}},"order.fulfillment.shipment.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_fulfillment_shipment_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","fulfillment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","resource_url":"/v1/fulfillments/ful_123","state":"in_progress","type":"shipment","updated_at":"2026-07-03T14:30:00Z"},"fulfillment_id":"ful_123","merchant_id":"mer_123","mode":"test","order":{"fulfillment_status":"partially_fulfilled","order_id":"ord_123","status":"open"},"order_id":"ord_123","partner_app_install_id":"pinst_123","shipment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","shipment_id":"fulsh_123","status":"created","updated_at":"2026-07-03T14:30:00Z"},"shipment_id":"fulsh_123","source_type":"installed_merchants"},"event_type":"order.fulfillment.shipment.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"fulfillment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","resource_url":"/v1/fulfillments/ful_123","state":"in_progress","type":"shipment","updated_at":"2026-07-03T14:30:00Z"},"fulfillment_id":"ful_123","order":{"fulfillment_status":"partially_fulfilled","order_id":"ord_123","status":"open"},"order_id":"ord_123","shipment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","shipment_id":"fulsh_123","status":"created","updated_at":"2026-07-03T14:30:00Z"},"shipment_id":"fulsh_123"},"event_type":"order.fulfillment.shipment.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_fulfillment_shipment_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_fulfillment_shipment_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A shipment was created."}},"order.fulfillment.shipment.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_fulfillment_shipment_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"current_status":"shipped","environment_grant_id":"egrt_123","fulfillment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","resource_url":"/v1/fulfillments/ful_123","state":"in_progress","type":"shipment","updated_at":"2026-07-03T14:30:00Z"},"fulfillment_id":"ful_123","merchant_id":"mer_123","mode":"test","order":{"fulfillment_status":"partially_fulfilled","order_id":"ord_123","status":"open"},"order_id":"ord_123","partner_app_install_id":"pinst_123","previous_status":"created","shipment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","shipment_id":"fulsh_123","status":"shipped","updated_at":"2026-07-03T14:30:00Z"},"shipment_id":"fulsh_123","shipment_status_update":{"buyer_notification_behavior":"default","created_at":"2026-07-03T14:30:00Z","current_status":"shipped","fulfillment_id":"ful_123","occurred_at":"2026-07-03T14:30:00Z","order_id":"ord_123","previous_status":"created","shipment_id":"fulsh_123","shipment_status_update_id":"fulshsu_123"},"shipment_status_update_id":"fulshsu_123","source_type":"installed_merchants"},"event_type":"order.fulfillment.shipment.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"current_status":"shipped","fulfillment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","resource_url":"/v1/fulfillments/ful_123","state":"in_progress","type":"shipment","updated_at":"2026-07-03T14:30:00Z"},"fulfillment_id":"ful_123","order":{"fulfillment_status":"partially_fulfilled","order_id":"ord_123","status":"open"},"order_id":"ord_123","previous_status":"created","shipment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","shipment_id":"fulsh_123","status":"shipped","updated_at":"2026-07-03T14:30:00Z"},"shipment_id":"fulsh_123","shipment_status_update":{"buyer_notification_behavior":"default","created_at":"2026-07-03T14:30:00Z","current_status":"shipped","fulfillment_id":"ful_123","occurred_at":"2026-07-03T14:30:00Z","order_id":"ord_123","previous_status":"created","shipment_id":"fulsh_123","shipment_status_update_id":"fulshsu_123"},"shipment_status_update_id":"fulshsu_123"},"event_type":"order.fulfillment.shipment.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_fulfillment_shipment_updated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_fulfillment_shipment_updated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A shipment status changed."}},"order.fulfillment.status_changed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_fulfillment_status_changed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"current_status":"in_progress","environment_grant_id":"egrt_123","fulfillment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","resource_url":"/v1/fulfillments/ful_123","state":"in_progress","type":"shipment","updated_at":"2026-07-03T14:30:00Z"},"fulfillment_id":"ful_123","fulfillment_status_update":{"buyer_notification_behavior":"default","created_at":"2026-07-03T14:30:00Z","current_status":"in_progress","fulfillment_id":"ful_123","fulfillment_status_update_id":"fulsu_123","occurred_at":"2026-07-03T14:30:00Z","order_id":"ord_123","previous_status":"pending","quantity_effect":"preserve"},"fulfillment_status_update_id":"fulsu_123","merchant_id":"mer_123","mode":"test","order":{"fulfillment_status":"partially_fulfilled","order_id":"ord_123","status":"open"},"order_id":"ord_123","partner_app_install_id":"pinst_123","previous_status":"pending","source_type":"installed_merchants"},"event_type":"order.fulfillment.status_changed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"current_status":"in_progress","fulfillment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","resource_url":"/v1/fulfillments/ful_123","state":"in_progress","type":"shipment","updated_at":"2026-07-03T14:30:00Z"},"fulfillment_id":"ful_123","fulfillment_status_update":{"buyer_notification_behavior":"default","created_at":"2026-07-03T14:30:00Z","current_status":"in_progress","fulfillment_id":"ful_123","fulfillment_status_update_id":"fulsu_123","occurred_at":"2026-07-03T14:30:00Z","order_id":"ord_123","previous_status":"pending","quantity_effect":"preserve"},"fulfillment_status_update_id":"fulsu_123","order":{"fulfillment_status":"partially_fulfilled","order_id":"ord_123","status":"open"},"order_id":"ord_123","previous_status":"pending"},"event_type":"order.fulfillment.status_changed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_fulfillment_status_changed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_fulfillment_status_changed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A fulfillment moved between pending, completed, and canceled."}},"order.fulfillment.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_fulfillment_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","fulfillment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","resource_url":"/v1/fulfillments/ful_123","state":"in_progress","type":"shipment","updated_at":"2026-07-03T14:30:00Z"},"fulfillment_id":"ful_123","merchant_id":"mer_123","mode":"test","order":{"fulfillment_status":"partially_fulfilled","order_id":"ord_123","status":"open"},"order_id":"ord_123","partner_app_install_id":"pinst_123","source_type":"installed_merchants"},"event_type":"order.fulfillment.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"fulfillment":{"created_at":"2026-07-03T14:30:00Z","fulfillment_id":"ful_123","order_id":"ord_123","resource_url":"/v1/fulfillments/ful_123","state":"in_progress","type":"shipment","updated_at":"2026-07-03T14:30:00Z"},"fulfillment_id":"ful_123","order":{"fulfillment_status":"partially_fulfilled","order_id":"ord_123","status":"open"},"order_id":"ord_123"},"event_type":"order.fulfillment.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_fulfillment_updated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_fulfillment_updated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A materialized order fulfillment changed execution state or detail."}},"order.inventory_action_required":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_inventory_action_required","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"order_id":"ord_123","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"order.inventory_action_required","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_order_inventory_action_required_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An order requires a safe merchant inventory action before fulfillment can continue."}},"order.inventory_exception.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_inventory_exception_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","inventory_exception_reason":"inventory_deduction_failed","inventory_exception_status":"paid_inventory_failed","inventory_exception_updated_at":"2026-07-03T14:30:00Z","merchant_id":"mer_123","mode":"test","order_id":"ord_123","order_number":"1001","partner_app_install_id":"pinst_123","payment_status":"paid","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"closed"},"event_type":"order.inventory_exception.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"inventory_exception_reason":"inventory_deduction_failed","inventory_exception_status":"paid_inventory_failed","inventory_exception_updated_at":"2026-07-03T14:30:00Z","order_id":"ord_123","order_number":"1001","payment_status":"paid","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"closed"},"event_type":"order.inventory_exception.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_inventory_exception_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_inventory_exception_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An order has an inventory failure that requires operator action."}},"order.inventory_exception.resolved":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_inventory_exception_resolved","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","inventory_exception_reason":"resolved_by_admin","inventory_exception_status":"resolved","inventory_exception_updated_at":"2026-07-03T14:30:00Z","merchant_id":"mer_123","mode":"test","order_id":"ord_123","order_number":"1001","partner_app_install_id":"pinst_123","payment_status":"paid","refund_status":"refunded","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"closed"},"event_type":"order.inventory_exception.resolved","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"inventory_exception_reason":"resolved_by_admin","inventory_exception_status":"resolved","inventory_exception_updated_at":"2026-07-03T14:30:00Z","order_id":"ord_123","order_number":"1001","payment_status":"paid","refund_status":"refunded","resource_updated_at":"2026-07-03T14:30:00Z","status":"closed"},"event_type":"order.inventory_exception.resolved","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_inventory_exception_resolved_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_inventory_exception_resolved_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An order inventory exception was resolved."}},"order.paid":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_paid","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","line_items":[{"name":"Red shirt","order_line_item_id":"li_123","quantity":1,"unit_price_money":{"amount":2500,"currency":"USD"}}],"merchant_id":"mer_123","mode":"test","order_id":"ord_123","order_payment_intent_ids":["pi_123"],"outstanding_money":{"amount":0,"currency":"USD"},"paid_money":{"amount":2500,"currency":"USD"},"partner_app_install_id":"pinst_123","payment_status":"paid","source_type":"installed_merchants","status":"closed","total_money":{"amount":2500,"currency":"USD"}},"event_type":"order.paid","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"line_items":[{"name":"Red shirt","order_line_item_id":"li_123","quantity":1,"unit_price_money":{"amount":2500,"currency":"USD"}}],"order_id":"ord_123","order_payment_intent_ids":["pi_123"],"outstanding_money":{"amount":0,"currency":"USD"},"paid_money":{"amount":2500,"currency":"USD"},"payment_status":"paid","status":"closed","total_money":{"amount":2500,"currency":"USD"}},"event_type":"order.paid","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_paid_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_paid_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An order became fully paid. Use order.payment_captured for each captured increment."}},"order.partially_paid":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_partially_paid","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","line_items":[{"name":"Red shirt","order_line_item_id":"li_123","quantity":1,"unit_price_money":{"amount":5000,"currency":"USD"}}],"merchant_id":"mer_123","mode":"test","order_id":"ord_123","order_payment_intent_ids":["pi_123"],"outstanding_money":{"amount":2500,"currency":"USD"},"paid_money":{"amount":2500,"currency":"USD"},"partner_app_install_id":"pinst_123","payment_status":"partially_paid","source_type":"installed_merchants","status":"open","total_money":{"amount":5000,"currency":"USD"}},"event_type":"order.partially_paid","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"line_items":[{"name":"Red shirt","order_line_item_id":"li_123","quantity":1,"unit_price_money":{"amount":5000,"currency":"USD"}}],"order_id":"ord_123","order_payment_intent_ids":["pi_123"],"outstanding_money":{"amount":2500,"currency":"USD"},"paid_money":{"amount":2500,"currency":"USD"},"payment_status":"partially_paid","status":"open","total_money":{"amount":5000,"currency":"USD"}},"event_type":"order.partially_paid","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_partially_paid_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_partially_paid_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An order first became partially paid. Use order.payment_captured for each captured increment."}},"order.payment_authorization_canceled":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_payment_authorization_canceled","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","order_id":"ord_123","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"order.payment_authorization_canceled","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"order_id":"ord_123","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"order.payment_authorization_canceled","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_payment_authorization_canceled_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_payment_authorization_canceled_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An authorization on an order was canceled."}},"order.payment_authorization_expired":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_payment_authorization_expired","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","order_id":"ord_123","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"order.payment_authorization_expired","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"order_id":"ord_123","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"order.payment_authorization_expired","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_payment_authorization_expired_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_payment_authorization_expired_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An authorization on an order expired before capture."}},"order.payment_authorized":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_payment_authorized","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","order_id":"ord_123","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"order.payment_authorized","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"order_id":"ord_123","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"order.payment_authorized","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_payment_authorized_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_payment_authorized_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A payment on an order was authorized and is awaiting capture."}},"order.payment_captured":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_payment_captured","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","order_id":"ord_123","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"order.payment_captured","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"order_id":"ord_123","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"order.payment_captured","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_payment_captured_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_payment_captured_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An authorized payment on an order was captured."}},"order.refunded":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_refunded","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","order_id":"ord_123","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"refunded"},"event_type":"order.refunded","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"order_id":"ord_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"refunded"},"event_type":"order.refunded","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_refunded_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_refunded_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An order received a full or partial refund."}},"order.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_order_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"customer_id":"cus_123","environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","order_id":"ord_123","order_number":"1001","partner_app_install_id":"pinst_123","payment_status":"unpaid","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"open"},"event_type":"order.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"customer_id":"cus_123","order_id":"ord_123","order_number":"1001","payment_status":"unpaid","refund_status":"none","resource_updated_at":"2026-07-03T14:30:00Z","status":"open"},"event_type":"order.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_order_updated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_order_updated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An order was updated."}},"partner_app.install.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_partner_app_install_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"partner_app":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"granted_scopes":["commerce.orders.read"],"merchant_id":"mer_123","partner_app_id":"pa_123","partner_app_install_id":"pinst_123","status":"active"},"event_type":"partner_app.install.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_partner_app_install_created_partner_app","title":"Partner app"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A partner app install was created."}},"partner_app.install.environment_grant.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_partner_app_install_environment_grant_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"partner_app":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","environment_id":"test_01J00000000000000000000000","granted_scopes":["commerce.orders.read"],"merchant_id":"mer_123","mode":"test","partner_app_id":"pa_123","partner_app_install_id":"pinst_123","status":"active"},"event_type":"partner_app.install.environment_grant.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_partner_app_install_environment_grant_created_partner_app","title":"Partner app"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A merchant environment was granted to a partner app install."}},"partner_app.install.environment_grant.revoked":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_partner_app_install_environment_grant_revoked","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"partner_app":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","environment_id":"test_01J00000000000000000000000","granted_scopes":["commerce.orders.read"],"merchant_id":"mer_123","mode":"test","partner_app_id":"pa_123","partner_app_install_id":"pinst_123","status":"revoked"},"event_type":"partner_app.install.environment_grant.revoked","partner_app_id":"pa_123","webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_partner_app_install_environment_grant_revoked_partner_app","title":"Partner app"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A merchant environment grant was revoked from a partner app install."}},"partner_app.install.permissions_updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_partner_app_install_permissions_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"partner_app":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"granted_scopes":["commerce.orders.read"],"merchant_id":"mer_123","partner_app_id":"pa_123","partner_app_install_id":"pinst_123","status":"active"},"event_type":"partner_app.install.permissions_updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_partner_app_install_permissions_updated_partner_app","title":"Partner app"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A partner app install's granted permissions changed."}},"partner_app.install.revoked":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_partner_app_install_revoked","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"partner_app":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"granted_scopes":["commerce.orders.read"],"merchant_id":"mer_123","partner_app_id":"pa_123","partner_app_install_id":"pinst_123","status":"revoked"},"event_type":"partner_app.install.revoked","partner_app_id":"pa_123","webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_partner_app_install_revoked_partner_app","title":"Partner app"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A partner app install was revoked."}},"partner_app.install.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_partner_app_install_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"partner_app":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"granted_scopes":["commerce.orders.read"],"merchant_id":"mer_123","partner_app_id":"pa_123","partner_app_install_id":"pinst_123","status":"active"},"event_type":"partner_app.install.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_partner_app_install_updated_partner_app","title":"Partner app"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A partner app install changed."}},"payment_intent.canceled":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payment_intent_canceled","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","payment_intent_id":"pi_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"canceled"},"event_type":"payment_intent.canceled","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"payment_intent_id":"pi_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"canceled"},"event_type":"payment_intent.canceled","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_payment_intent_canceled_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_payment_intent_canceled_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A payment intent was canceled."}},"payment_intent.fulfillment_hold.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payment_intent_fulfillment_hold_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","fulfillment_hold":{"reason":"external_payment_hold","requested_at":"2026-07-03T14:30:00Z","required_action":"pause_fulfillment","status":"active","updated_at":"2026-07-03T14:30:00Z"},"merchant_id":"mer_123","mode":"test","object":"payment_intent","order_id":"ord_123","partner_app_install_id":"pinst_123","payment_intent_id":"pi_123","source_type":"installed_merchants"},"event_type":"payment_intent.fulfillment_hold.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"fulfillment_hold":{"reason":"external_payment_hold","requested_at":"2026-07-03T14:30:00Z","required_action":"pause_fulfillment","status":"active","updated_at":"2026-07-03T14:30:00Z"},"object":"payment_intent","order_id":"ord_123","payment_intent_id":"pi_123"},"event_type":"payment_intent.fulfillment_hold.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_payment_intent_fulfillment_hold_updated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_payment_intent_fulfillment_hold_updated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A payment intent fulfillment hold was activated or released."}},"payment_intent.payment_failed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payment_intent_payment_failed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","payment_intent_id":"pi_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"failed"},"event_type":"payment_intent.payment_failed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"payment_intent_id":"pi_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"failed"},"event_type":"payment_intent.payment_failed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_payment_intent_payment_failed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_payment_intent_payment_failed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A payment attempt failed."}},"payment_intent.processing":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payment_intent_processing","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","payment_intent_id":"pi_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"payment_intent.processing","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"payment_intent_id":"pi_123","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"payment_intent.processing","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_payment_intent_processing_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_payment_intent_processing_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A payment was submitted and is awaiting its final outcome."}},"payment_intent.requires_action":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payment_intent_requires_action","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","payment_intent_id":"pi_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"requires_action"},"event_type":"payment_intent.requires_action","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"payment_intent_id":"pi_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"requires_action"},"event_type":"payment_intent.requires_action","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_payment_intent_requires_action_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_payment_intent_requires_action_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"The payment requires a customer action such as 3D Secure authentication."}},"payment_intent.requires_capture":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payment_intent_requires_capture","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","payment_intent_id":"pi_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"requires_capture"},"event_type":"payment_intent.requires_capture","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"payment_intent_id":"pi_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"requires_capture"},"event_type":"payment_intent.requires_capture","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_payment_intent_requires_capture_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_payment_intent_requires_capture_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"The payment was authorized and is awaiting capture."}},"payment_intent.succeeded":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payment_intent_succeeded","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","payment_intent_id":"pi_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"paid"},"event_type":"payment_intent.succeeded","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"payment_intent_id":"pi_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"paid"},"event_type":"payment_intent.succeeded","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_payment_intent_succeeded_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_payment_intent_succeeded_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A payment intent succeeded."}},"payment_method.failed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payment_method_failed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"customer_id":"cus_123","environment_grant_id":"egrt_123","failure_code":"insufficient_funds","failure_message":"The card has insufficient funds.","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","payment_method_id":"pm_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"failed"},"event_type":"payment_method.failed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"customer_id":"cus_123","failure_code":"insufficient_funds","failure_message":"The card has insufficient funds.","payment_method_id":"pm_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"failed"},"event_type":"payment_method.failed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_payment_method_failed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_payment_method_failed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"Saving a payment method failed."}},"payment_method.removed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payment_method_removed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","payment_method_id":"pm_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"removed"},"event_type":"payment_method.removed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"payment_method_id":"pm_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"removed"},"event_type":"payment_method.removed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_payment_method_removed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_payment_method_removed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A saved payment method was removed."}},"payment_method.saved":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payment_method_saved","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"card_brand":"visa","card_exp_month":12,"card_exp_year":2030,"card_last4":"4242","card_wallet":"apple_pay","customer_id":"cus_123","environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","payment_method_id":"pm_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"active"},"event_type":"payment_method.saved","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"card_brand":"visa","card_exp_month":12,"card_exp_year":2030,"card_last4":"4242","card_wallet":"apple_pay","customer_id":"cus_123","payment_method_id":"pm_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"active"},"event_type":"payment_method.saved","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_payment_method_saved_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_payment_method_saved_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A payment method was saved to a customer."}},"payout.canceled":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payout_canceled","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"payout_id":"po_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"canceled"},"event_type":"payout.canceled","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_payout_canceled_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A payout to the merchant's bank was canceled."}},"payout.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payout_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"payout_id":"po_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"created"},"event_type":"payout.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_payout_created_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A payout to the merchant's bank was created."}},"payout.failed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payout_failed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"payout_id":"po_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"failed"},"event_type":"payout.failed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_payout_failed_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A payout failed and funds were returned to the balance."}},"payout.paid":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payout_paid","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"payout_id":"po_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"paid"},"event_type":"payout.paid","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_payout_paid_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A payout arrived at the merchant's bank."}},"payout.reversed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payout_reversed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"payout_id":"po_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"reversed"},"event_type":"payout.reversed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_payout_reversed_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A completed payout was reversed."}},"payout.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payout_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"payout_id":"po_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"updated"},"event_type":"payout.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_payout_updated_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A payout changed state."}},"payout_destination.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payout_destination_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"payout_destination_id":"pdest_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"created"},"event_type":"payout_destination.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_payout_destination_created_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A payout destination (bank account) was added."}},"payout_destination.deleted":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payout_destination_deleted","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"payout_destination_id":"pdest_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"deleted"},"event_type":"payout_destination.deleted","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_payout_destination_deleted_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A payout destination was removed."}},"payout_destination.disabled":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payout_destination_disabled","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"payout_destination_id":"pdest_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"disabled"},"event_type":"payout_destination.disabled","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_payout_destination_disabled_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A payout destination was disabled."}},"payout_destination.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payout_destination_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"payout_destination_id":"pdest_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"updated"},"event_type":"payout_destination.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_payout_destination_updated_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A payout destination was updated."}},"payout_settings.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_payout_settings_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"payout_settings_id":"pset_123","resource_updated_at":"2026-07-03T14:30:00Z","status":"updated"},"event_type":"payout_settings.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"$ref":"#/components/schemas/Webhook_payout_settings_updated_merchant","title":"Merchant"}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"The merchant's payout schedule or settings changed."}},"refund.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_refund_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","refund_id":"ref_123","return_id":"ret_123","return_resolution_id":"retres_123","source_type":"installed_merchants"},"event_type":"refund.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"refund_id":"ref_123","return_id":"ret_123","return_resolution_id":"retres_123"},"event_type":"refund.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_refund_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_refund_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A refund was created."}},"refund.failed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_refund_failed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","refund_id":"ref_123","return_id":"ret_123","return_resolution_id":"retres_123","source_type":"installed_merchants"},"event_type":"refund.failed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"refund_id":"ref_123","return_id":"ret_123","return_resolution_id":"retres_123"},"event_type":"refund.failed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_refund_failed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_refund_failed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A refund failed."}},"refund.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_refund_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","refund_id":"ref_123","return_id":"ret_123","return_resolution_id":"retres_123","source_type":"installed_merchants"},"event_type":"refund.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"refund_id":"ref_123","return_id":"ret_123","return_resolution_id":"retres_123"},"event_type":"refund.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_refund_updated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_refund_updated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A refund changed state."}},"report.failed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_report_failed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"created_at":"2026-07-03T14:30:00Z","currency":"USD","environment_grant_id":"egrt_123","failure_reason":"generation_failed","interval_end_at":"2026-07-01T00:00:00Z","interval_start_at":"2026-06-01T00:00:00Z","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","report_id":"rep_01J00000000000000000000000","report_type":"orders_itemized_v1","source_type":"installed_merchants","status":"failed","timezone":"UTC"},"event_type":"report.failed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"created_at":"2026-07-03T14:30:00Z","currency":"USD","failure_reason":"generation_failed","interval_end_at":"2026-07-01T00:00:00Z","interval_start_at":"2026-06-01T00:00:00Z","report_id":"rep_01J00000000000000000000000","report_type":"orders_itemized_v1","status":"failed","timezone":"UTC"},"event_type":"report.failed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_report_failed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_report_failed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An asynchronous report reached a terminal generation failure."}},"report.succeeded":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_report_succeeded","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"created_at":"2026-07-03T14:30:00Z","currency":"USD","download":{"expires_at":"2026-07-04T14:30:00Z","report_download_id":"rdl_01J00000000000000000000000","url":"https://files.withflintpay.com/reports/report.csv"},"environment_grant_id":"egrt_123","interval_end_at":"2026-07-01T00:00:00Z","interval_start_at":"2026-06-01T00:00:00Z","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","report_id":"rep_01J00000000000000000000000","report_type":"orders_itemized_v1","source_type":"installed_merchants","status":"succeeded","timezone":"UTC"},"event_type":"report.succeeded","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"created_at":"2026-07-03T14:30:00Z","currency":"USD","download":{"expires_at":"2026-07-04T14:30:00Z","report_download_id":"rdl_01J00000000000000000000000","url":"https://files.withflintpay.com/reports/report.csv"},"interval_end_at":"2026-07-01T00:00:00Z","interval_start_at":"2026-06-01T00:00:00Z","report_id":"rep_01J00000000000000000000000","report_type":"orders_itemized_v1","status":"succeeded","timezone":"UTC"},"event_type":"report.succeeded","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_report_succeeded_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_report_succeeded_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An asynchronous report completed and its authenticated CSV download is ready."}},"return.canceled":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_return_canceled","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"return.canceled","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"return.canceled","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"return.canceled","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"return.canceled","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_return_canceled_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_return_canceled_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A Return was canceled."}},"return.completed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_return_completed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"return.completed","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"return.completed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"return.completed","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"return.completed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_return_completed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_return_completed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A Return completed after every required merchandise and buyer-value obligation cleared."}},"return.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_return_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"return.created","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"return.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"return.created","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"return.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_return_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_return_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A Return was created."}},"return.decision_recorded":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_return_decision_recorded","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"return.decision_recorded","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"return.decision_recorded","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"return.decision_recorded","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"return.decision_recorded","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_return_decision_recorded_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_return_decision_recorded_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"The merchant or policy automation recorded line-level Return decisions."}},"return.reopened":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_return_reopened","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"return.reopened","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"return.reopened","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"return.reopened","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"return.reopened","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_return_reopened_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_return_reopened_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A completed Return was reopened for additional work."}},"return.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_return_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"return.updated","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"return.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"return.updated","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"return.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_return_updated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_return_updated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A Return or one of its line-level progress projections changed."}},"return_disposition.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_return_disposition_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"return_disposition.created","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"return_disposition.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"return_disposition.created","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"return_disposition.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_return_disposition_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_return_disposition_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A merchandise disposition was recorded for a Return."}},"return_disposition.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_return_disposition_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"return_disposition.updated","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"return_disposition.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"return_disposition.updated","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"return_disposition.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_return_disposition_updated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_return_disposition_updated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A Return disposition changed execution state."}},"return_inspection.acceptance_decided":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_return_inspection_acceptance_decided","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"return_inspection.acceptance_decided","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"return_inspection.acceptance_decided","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"return_inspection.acceptance_decided","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"return_inspection.acceptance_decided","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_return_inspection_acceptance_decided_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_return_inspection_acceptance_decided_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"Acceptance was decided for a Return inspection observation."}},"return_inspection.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_return_inspection_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"return_inspection.created","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"return_inspection.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"return_inspection.created","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"return_inspection.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_return_inspection_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_return_inspection_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A Return inspection observation was recorded."}},"return_inspection.superseded":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_return_inspection_superseded","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"return_inspection.superseded","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"return_inspection.superseded","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"return_inspection.superseded","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"return_inspection.superseded","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_return_inspection_superseded_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_return_inspection_superseded_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A Return inspection observation was superseded by an auditable correction."}},"return_receipt.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_return_receipt_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"return_receipt.created","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"return_receipt.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"return_receipt.created","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"return_receipt.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_return_receipt_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_return_receipt_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A Return receipt observation was recorded."}},"return_receipt.superseded":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_return_receipt_superseded","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"return_receipt.superseded","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"return_receipt.superseded","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"return_receipt.superseded","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"return_receipt.superseded","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_return_receipt_superseded_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_return_receipt_superseded_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A Return receipt observation was superseded by an auditable correction."}},"return_receipt.verified":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_return_receipt_verified","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"return_receipt.verified","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"return_receipt.verified","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"return_receipt.verified","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"return_receipt.verified","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_return_receipt_verified_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_return_receipt_verified_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"An unmatched Return receipt line was verified against the expected merchandise."}},"return_resolution.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_return_resolution_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"return_resolution.created","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"return_resolution.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"return_resolution.created","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"return_resolution.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_return_resolution_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_return_resolution_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A proposed buyer-value resolution was created for a Return."}},"return_resolution.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_return_resolution_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","event_type":"return_resolution.updated","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants"},"event_type":"return_resolution.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"event_type":"return_resolution.updated","resource_updated_at":"2026-07-03T14:30:00Z"},"event_type":"return_resolution.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_return_resolution_updated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_return_resolution_updated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A Return resolution changed proposal, gate, effect, or fulfillment state."}},"review.closed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_review_closed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"closed_at":"2026-07-03T14:30:00Z","closed_by":null,"closed_reason":"approved","customer_id":null,"environment_grant_id":"egrt_123","ip_address":null,"ip_address_location":null,"matched_risk_rule_id":null,"merchant_id":"mer_123","mode":"test","opened_at":"2026-07-03T14:30:00Z","opened_reason":"rule","order_id":null,"partner_app_install_id":"pinst_123","payment_flow":"checkout","payment_intent_id":"pi_123","payment_summary":{"amount_money":{"amount":12900,"currency":"USD"},"authorization_expires_at":null,"capture_method":"automatic","email":"buyer@example.com","last4":"4242","payment_method_brand":"visa"},"pending_action":null,"refund_id":null,"refunded_amount_money":null,"resolution_started_at":null,"resolution_started_by":null,"review_id":"rev_123","risk":{"level":"elevated","score":null},"source_type":"installed_merchants","status":"closed"},"event_type":"review.closed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"closed_at":"2026-07-03T14:30:00Z","closed_by":null,"closed_reason":"approved","customer_id":null,"ip_address":null,"ip_address_location":null,"matched_risk_rule_id":null,"opened_at":"2026-07-03T14:30:00Z","opened_reason":"rule","order_id":null,"payment_flow":"checkout","payment_intent_id":"pi_123","payment_summary":{"amount_money":{"amount":12900,"currency":"USD"},"authorization_expires_at":null,"capture_method":"automatic","email":"buyer@example.com","last4":"4242","payment_method_brand":"visa"},"pending_action":null,"refund_id":null,"refunded_amount_money":null,"resolution_started_at":null,"resolution_started_by":null,"review_id":"rev_123","risk":{"level":"elevated","score":null},"status":"closed"},"event_type":"review.closed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_review_closed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_review_closed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A payment review was resolved or closed by a payment lifecycle change."}},"review.opened":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_review_opened","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"closed_at":null,"closed_by":null,"closed_reason":null,"customer_id":null,"environment_grant_id":"egrt_123","ip_address":null,"ip_address_location":null,"matched_risk_rule_id":null,"merchant_id":"mer_123","mode":"test","opened_at":"2026-07-03T14:30:00Z","opened_reason":"rule","order_id":null,"partner_app_install_id":"pinst_123","payment_flow":"checkout","payment_intent_id":"pi_123","payment_summary":{"amount_money":{"amount":12900,"currency":"USD"},"authorization_expires_at":null,"capture_method":"automatic","email":"buyer@example.com","last4":"4242","payment_method_brand":"visa"},"pending_action":null,"refund_id":null,"refunded_amount_money":null,"resolution_started_at":null,"resolution_started_by":null,"review_id":"rev_123","risk":{"level":"elevated","score":null},"source_type":"installed_merchants","status":"open"},"event_type":"review.opened","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"closed_at":null,"closed_by":null,"closed_reason":null,"customer_id":null,"ip_address":null,"ip_address_location":null,"matched_risk_rule_id":null,"opened_at":"2026-07-03T14:30:00Z","opened_reason":"rule","order_id":null,"payment_flow":"checkout","payment_intent_id":"pi_123","payment_summary":{"amount_money":{"amount":12900,"currency":"USD"},"authorization_expires_at":null,"capture_method":"automatic","email":"buyer@example.com","last4":"4242","payment_method_brand":"visa"},"pending_action":null,"refund_id":null,"refunded_amount_money":null,"resolution_started_at":null,"resolution_started_by":null,"review_id":"rev_123","risk":{"level":"elevated","score":null},"status":"open"},"event_type":"review.opened","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_review_opened_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_review_opened_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A payment was placed into manual review."}},"subscription.activated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_subscription_activated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"active","subscription_id":"sub_123"},"event_type":"subscription.activated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"resource_updated_at":"2026-07-03T14:30:00Z","status":"active","subscription_id":"sub_123"},"event_type":"subscription.activated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_subscription_activated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_subscription_activated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A subscription became active."}},"subscription.canceled":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_subscription_canceled","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"canceled","subscription_id":"sub_123"},"event_type":"subscription.canceled","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"resource_updated_at":"2026-07-03T14:30:00Z","status":"canceled","subscription_id":"sub_123"},"event_type":"subscription.canceled","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_subscription_canceled_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_subscription_canceled_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A subscription was canceled."}},"subscription.created":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_subscription_created","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"created","subscription_id":"sub_123"},"event_type":"subscription.created","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"resource_updated_at":"2026-07-03T14:30:00Z","status":"created","subscription_id":"sub_123"},"event_type":"subscription.created","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_subscription_created_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_subscription_created_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A subscription was created."}},"subscription.dunning_exhausted":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_subscription_dunning_exhausted","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"dunning_end_action":"notify_only","environment_grant_id":"egrt_123","failed_period_ended_at":"2026-07-03T14:30:00Z","failed_period_started_at":"2026-06-03T14:30:00Z","merchant_id":"mer_123","mode":"test","order_id":"ord_123","partner_app_install_id":"pinst_123","payment_attempt_id":"pi_123","resource_updated_at":"2026-07-19T14:30:00Z","scheduled_billing_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"past_due","subscription_id":"sub_123"},"event_type":"subscription.dunning_exhausted","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"dunning_end_action":"notify_only","failed_period_ended_at":"2026-07-03T14:30:00Z","failed_period_started_at":"2026-06-03T14:30:00Z","order_id":"ord_123","payment_attempt_id":"pi_123","resource_updated_at":"2026-07-19T14:30:00Z","scheduled_billing_at":"2026-07-03T14:30:00Z","status":"past_due","subscription_id":"sub_123"},"event_type":"subscription.dunning_exhausted","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_subscription_dunning_exhausted_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_subscription_dunning_exhausted_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A subscription used its automatic payment retry budget."}},"subscription.past_due":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_subscription_past_due","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"past_due","subscription_id":"sub_123"},"event_type":"subscription.past_due","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"resource_updated_at":"2026-07-03T14:30:00Z","status":"past_due","subscription_id":"sub_123"},"event_type":"subscription.past_due","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_subscription_past_due_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_subscription_past_due_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A subscription renewal failed and is past due."}},"subscription.paused":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_subscription_paused","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"paused","subscription_id":"sub_123"},"event_type":"subscription.paused","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"resource_updated_at":"2026-07-03T14:30:00Z","status":"paused","subscription_id":"sub_123"},"event_type":"subscription.paused","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_subscription_paused_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_subscription_paused_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A subscription was paused."}},"subscription.payment_failed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_subscription_payment_failed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","order_id":"ord_123","partner_app_install_id":"pinst_123","scheduled_billing_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","subscription_id":"sub_123"},"event_type":"subscription.payment_failed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"order_id":"ord_123","scheduled_billing_at":"2026-07-03T14:30:00Z","subscription_id":"sub_123"},"event_type":"subscription.payment_failed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_subscription_payment_failed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_subscription_payment_failed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A subscription billing attempt failed."}},"subscription.payment_succeeded":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_subscription_payment_succeeded","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"paid","subscription_id":"sub_123"},"event_type":"subscription.payment_succeeded","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"resource_updated_at":"2026-07-03T14:30:00Z","status":"paid","subscription_id":"sub_123"},"event_type":"subscription.payment_succeeded","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_subscription_payment_succeeded_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_subscription_payment_succeeded_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A subscription billing attempt succeeded."}},"subscription.renewal_upcoming":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_subscription_renewal_upcoming","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","next_billing_at":"2026-08-03T14:30:00Z","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","subscription_id":"sub_123"},"event_type":"subscription.renewal_upcoming","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"next_billing_at":"2026-08-03T14:30:00Z","resource_updated_at":"2026-07-03T14:30:00Z","subscription_id":"sub_123"},"event_type":"subscription.renewal_upcoming","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_subscription_renewal_upcoming_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_subscription_renewal_upcoming_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A subscription renewal is approaching."}},"subscription.resumed":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_subscription_resumed","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","status":"active","subscription_id":"sub_123"},"event_type":"subscription.resumed","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"resource_updated_at":"2026-07-03T14:30:00Z","status":"active","subscription_id":"sub_123"},"event_type":"subscription.resumed","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_subscription_resumed_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_subscription_resumed_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A paused subscription was resumed."}},"subscription.trial_ending":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_subscription_trial_ending","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"environment_grant_id":"egrt_123","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","subscription_id":"sub_123"},"event_type":"subscription.trial_ending","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"resource_updated_at":"2026-07-03T14:30:00Z","subscription_id":"sub_123"},"event_type":"subscription.trial_ending","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_subscription_trial_ending_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_subscription_trial_ending_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A subscription trial is approaching its end."}},"subscription.updated":{"post":{"description":"Verify the webhook signature against the raw request body before processing the event. Return any 2xx status to acknowledge delivery.","operationId":"receive_subscription_updated","parameters":[{"description":"Webhook event ID.","in":"header","name":"webhook-id","required":true,"schema":{"type":"string"}},{"description":"Unix timestamp in seconds.","in":"header","name":"webhook-timestamp","required":true,"schema":{"type":"string"}},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","in":"header","name":"webhook-signature","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"installed_merchants":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"changed_fields":["next_billing_at","awaiting_billing_schedule"],"environment_grant_id":"egrt_123","initiated_by":"integration","merchant_id":"mer_123","mode":"test","partner_app_install_id":"pinst_123","previous_values":{"awaiting_billing_schedule":true,"next_billing_at":null},"resource_updated_at":"2026-07-03T14:30:00Z","source_type":"installed_merchants","subscription_id":"sub_123"},"event_type":"subscription.updated","partner_app_id":"pa_123","webhook_event_id":"whev_123"}},"merchant":{"value":{"api_version":"2026-09-07","created_at":"2026-07-03T14:30:00Z","data":{"changed_fields":["next_billing_at","awaiting_billing_schedule"],"initiated_by":"integration","previous_values":{"awaiting_billing_schedule":true,"next_billing_at":null},"resource_updated_at":"2026-07-03T14:30:00Z","subscription_id":"sub_123"},"event_type":"subscription.updated","merchant_id":"mer_123","mode":"test","payload_version":1,"request":null,"webhook_event_id":"whev_123"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/Webhook_subscription_updated_merchant","title":"Merchant"},{"$ref":"#/components/schemas/Webhook_subscription_updated_installed_merchants","title":"Installed merchants"}]}}},"required":true},"responses":{"2XX":{"description":"Delivery acknowledged."}},"security":[],"summary":"A subscription field changed without a more specific lifecycle event."}}},"x-flint-api-releases":{"current_version":"2026-09-07","releases":[{"version":"2026-02-01","changes":[],"affected_routes":[]},{"version":"2026-09-07","changes":[{"id":"balance-fee-convention","kind":"wire_shape","summary":"Balance transaction fee charges are positive and fee credits are negative.","schemas":["BalanceTransaction"],"operations":[]},{"id":"balance-related-resource","kind":"wire_shape","summary":"Balance transaction relationships use resource-specific IDs.","schemas":["BalanceTransaction"],"operations":[]},{"id":"balance-occurred-at","kind":"wire_shape","summary":"Balance transactions use occurred_at for the transaction timestamp.","schemas":["BalanceTransaction"],"operations":[]},{"id":"tax-category-names","kind":"wire_shape","summary":"Tax categories use line_item_tax_category for items and charge_tax_category for charges.","schemas":["AvailableModifier","Bundle","CreateBundleRequest","CreateModifierInput","Modifier","ModifierInput","ModifierOverride","OrderCalculatedLineItemTax","OrderDraftLineItemTaxInput","OrderLineItemTax","ProductVariant","ProductVariantInput","PublicResolvedModifierOption","UpdateBundleRequest","UpdateProductVariantRequest","DeliveryMethodConfiguration","DeliveryMethodConfigurationCreateInput","DeliveryMethodConfigurationInput","DeliveryOptionProjection","OrderCalculatedChargeTax"],"operations":[]}],"affected_routes":[{"route_pattern":"GET /v1/analytics/overview","method":"GET","path":"/v1/analytics/overview","operation_id":"getAnalyticsOverview","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/analytics/payment-volume-timeseries","method":"GET","path":"/v1/analytics/payment-volume-timeseries","operation_id":"getPaymentVolumeTimeseries","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/analytics/subscriptions","method":"GET","path":"/v1/analytics/subscriptions","operation_id":"getSubscriptionAnalytics","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/api-keys","method":"GET","path":"/v1/api-keys","operation_id":"listAPIKeys","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/api-keys","method":"POST","path":"/v1/api-keys","operation_id":"createAPIKey","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/api-keys/{api_key_id}","method":"GET","path":"/v1/api-keys/{api_key_id}","operation_id":"getAPIKey","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/api-keys/{api_key_id}","method":"PATCH","path":"/v1/api-keys/{api_key_id}","operation_id":"updateAPIKey","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/api-keys/{api_key_id}/revoke","method":"POST","path":"/v1/api-keys/{api_key_id}/revoke","operation_id":"revokeAPIKey","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/balance-transactions","method":"GET","path":"/v1/balance-transactions","operation_id":"listBalanceTransactions","change_ids":["balance-fee-convention","balance-occurred-at","balance-related-resource","tax-category-names"]},{"route_pattern":"GET /v1/balance-transactions/{balance_transaction_id}","method":"GET","path":"/v1/balance-transactions/{balance_transaction_id}","operation_id":"getBalanceTransaction","change_ids":["balance-fee-convention","balance-occurred-at","balance-related-resource","tax-category-names"]},{"route_pattern":"GET /v1/balances","method":"GET","path":"/v1/balances","operation_id":"listBalances","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/bundles","method":"GET","path":"/v1/bundles","operation_id":"listBundles","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/bundles","method":"POST","path":"/v1/bundles","operation_id":"createBundle","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/bundles/{bundle_id}","method":"DELETE","path":"/v1/bundles/{bundle_id}","operation_id":"deleteBundle","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/bundles/{bundle_id}","method":"GET","path":"/v1/bundles/{bundle_id}","operation_id":"getBundle","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/bundles/{bundle_id}","method":"PATCH","path":"/v1/bundles/{bundle_id}","operation_id":"updateBundle","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/bundles/{bundle_id}/components","method":"GET","path":"/v1/bundles/{bundle_id}/components","operation_id":"listBundleComponents","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/capabilities","method":"GET","path":"/v1/capabilities","operation_id":"listCapabilities","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/categories","method":"GET","path":"/v1/categories","operation_id":"listCategories","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/categories","method":"POST","path":"/v1/categories","operation_id":"createCategory","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/categories/{category_id}","method":"DELETE","path":"/v1/categories/{category_id}","operation_id":"deleteCategory","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/categories/{category_id}","method":"GET","path":"/v1/categories/{category_id}","operation_id":"getCategory","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/categories/{category_id}","method":"PATCH","path":"/v1/categories/{category_id}","operation_id":"updateCategory","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/checkout-sessions","method":"GET","path":"/v1/checkout-sessions","operation_id":"listCheckoutSessions","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/checkout-sessions","method":"POST","path":"/v1/checkout-sessions","operation_id":"createCheckoutSession","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/checkout-sessions/{checkout_session_id}","method":"GET","path":"/v1/checkout-sessions/{checkout_session_id}","operation_id":"getCheckoutSession","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/checkout-sessions/{checkout_session_id}","method":"PATCH","path":"/v1/checkout-sessions/{checkout_session_id}","operation_id":"updateCheckoutSession","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/checkout-sessions/{checkout_session_id}/close","method":"POST","path":"/v1/checkout-sessions/{checkout_session_id}/close","operation_id":"closeCheckoutSession","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/checkout-sessions/{checkout_session_id}/delivery-quotes","method":"POST","path":"/v1/checkout-sessions/{checkout_session_id}/delivery-quotes","operation_id":"createCheckoutSessionDeliveryQuote","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/checkout-sessions/{checkout_session_id}/delivery-quotes/{delivery_quote_id}","method":"GET","path":"/v1/checkout-sessions/{checkout_session_id}/delivery-quotes/{delivery_quote_id}","operation_id":"getCheckoutSessionDeliveryQuote","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/checkout-sessions/{checkout_session_id}/delivery-selections","method":"POST","path":"/v1/checkout-sessions/{checkout_session_id}/delivery-selections","operation_id":"createCheckoutSessionDeliverySelection","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/checkout-sessions/{checkout_session_id}/delivery-selections/current","method":"DELETE","path":"/v1/checkout-sessions/{checkout_session_id}/delivery-selections/current","operation_id":"deleteCheckoutSessionCurrentDeliverySelection","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/checkout-sessions/{checkout_session_id}/delivery-selections/current","method":"GET","path":"/v1/checkout-sessions/{checkout_session_id}/delivery-selections/current","operation_id":"getCheckoutSessionCurrentDeliverySelection","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/checkout-sessions/{checkout_session_id}/delivery-selections/{delivery_selection_id}","method":"GET","path":"/v1/checkout-sessions/{checkout_session_id}/delivery-selections/{delivery_selection_id}","operation_id":"getCheckoutSessionDeliverySelectionHistory","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/checkout-sessions/{checkout_session_id}/query-pickup-availability","method":"POST","path":"/v1/checkout-sessions/{checkout_session_id}/query-pickup-availability","operation_id":"queryCheckoutSessionPickupAvailability","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/credit-notes","method":"GET","path":"/v1/credit-notes","operation_id":"listCreditNotes","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/credit-notes","method":"POST","path":"/v1/credit-notes","operation_id":"createCreditNote","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/credit-notes/{credit_note_id}","method":"GET","path":"/v1/credit-notes/{credit_note_id}","operation_id":"getCreditNote","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/credit-notes/{credit_note_id}","method":"PATCH","path":"/v1/credit-notes/{credit_note_id}","operation_id":"updateCreditNote","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/credit-notes/{credit_note_id}/allocations","method":"GET","path":"/v1/credit-notes/{credit_note_id}/allocations","operation_id":"listCreditNoteAllocations","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/credit-notes/{credit_note_id}/allocations","method":"POST","path":"/v1/credit-notes/{credit_note_id}/allocations","operation_id":"createCreditNoteAllocation","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/credit-notes/{credit_note_id}/allocations/{credit_note_allocation_id}","method":"GET","path":"/v1/credit-notes/{credit_note_id}/allocations/{credit_note_allocation_id}","operation_id":"getCreditNoteAllocation","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/credit-notes/{credit_note_id}/allocations/{credit_note_allocation_id}/reverse","method":"POST","path":"/v1/credit-notes/{credit_note_id}/allocations/{credit_note_allocation_id}/reverse","operation_id":"reverseCreditNoteAllocation","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/credit-notes/{credit_note_id}/issue","method":"POST","path":"/v1/credit-notes/{credit_note_id}/issue","operation_id":"issueCreditNote","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/credit-notes/{credit_note_id}/pdf","method":"GET","path":"/v1/credit-notes/{credit_note_id}/pdf","operation_id":"getCreditNotePDF","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/credit-notes/{credit_note_id}/refunds","method":"GET","path":"/v1/credit-notes/{credit_note_id}/refunds","operation_id":"listCreditNoteRefunds","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/credit-notes/{credit_note_id}/refunds","method":"POST","path":"/v1/credit-notes/{credit_note_id}/refunds","operation_id":"createCreditNoteRefund","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/credit-notes/{credit_note_id}/void","method":"POST","path":"/v1/credit-notes/{credit_note_id}/void","operation_id":"voidCreditNote","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/customer-deletion-requests","method":"GET","path":"/v1/customer-deletion-requests","operation_id":"listCustomerDeletionRequests","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/customer-deletion-requests/{customer_deletion_request_id}/resolve","method":"POST","path":"/v1/customer-deletion-requests/{customer_deletion_request_id}/resolve","operation_id":"resolveCustomerDeletionRequest","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/customer-sessions","method":"POST","path":"/v1/customer-sessions","operation_id":"createCustomerSession","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/customer-sessions/refresh","method":"POST","path":"/v1/customer-sessions/refresh","operation_id":"refreshCustomerSession","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/customer-sessions/{customer_session_id}/revoke","method":"POST","path":"/v1/customer-sessions/{customer_session_id}/revoke","operation_id":"revokeCustomerSession","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/customers","method":"GET","path":"/v1/customers","operation_id":"listCustomers","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/customers","method":"POST","path":"/v1/customers","operation_id":"createCustomer","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/customers/{customer_id}","method":"GET","path":"/v1/customers/{customer_id}","operation_id":"getCustomer","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/customers/{customer_id}","method":"PATCH","path":"/v1/customers/{customer_id}","operation_id":"updateCustomer","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/customers/{customer_id}/addresses","method":"GET","path":"/v1/customers/{customer_id}/addresses","operation_id":"listCustomerAddresses","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/customers/{customer_id}/addresses","method":"POST","path":"/v1/customers/{customer_id}/addresses","operation_id":"createCustomerAddress","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/customers/{customer_id}/addresses/{customer_address_id}","method":"DELETE","path":"/v1/customers/{customer_id}/addresses/{customer_address_id}","operation_id":"deleteCustomerAddress","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/customers/{customer_id}/addresses/{customer_address_id}","method":"GET","path":"/v1/customers/{customer_id}/addresses/{customer_address_id}","operation_id":"getCustomerAddress","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/customers/{customer_id}/addresses/{customer_address_id}","method":"PATCH","path":"/v1/customers/{customer_id}/addresses/{customer_address_id}","operation_id":"updateCustomerAddress","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/customers/{customer_id}/addresses/{customer_address_id}/set-default","method":"POST","path":"/v1/customers/{customer_id}/addresses/{customer_address_id}/set-default","operation_id":"setDefaultCustomerAddress","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/customers/{customer_id}/deletion-requests","method":"POST","path":"/v1/customers/{customer_id}/deletion-requests","operation_id":"createCustomerDeletionRequest","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/customers/{customer_id}/deletion-requests/{customer_deletion_request_id}","method":"GET","path":"/v1/customers/{customer_id}/deletion-requests/{customer_deletion_request_id}","operation_id":"getCustomerDeletionRequest","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/customers/{customer_id}/sessions/revoke","method":"POST","path":"/v1/customers/{customer_id}/sessions/revoke","operation_id":"revokeCustomerSessions","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/delivery-location-sets","method":"GET","path":"/v1/delivery-location-sets","operation_id":"listDeliveryLocationSets","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/delivery-location-sets","method":"POST","path":"/v1/delivery-location-sets","operation_id":"createDeliveryLocationSet","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/delivery-location-sets/{delivery_location_set_id}","method":"DELETE","path":"/v1/delivery-location-sets/{delivery_location_set_id}","operation_id":"deleteDeliveryLocationSet","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/delivery-location-sets/{delivery_location_set_id}","method":"GET","path":"/v1/delivery-location-sets/{delivery_location_set_id}","operation_id":"getDeliveryLocationSet","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/delivery-location-sets/{delivery_location_set_id}","method":"PATCH","path":"/v1/delivery-location-sets/{delivery_location_set_id}","operation_id":"updateDeliveryLocationSet","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/delivery-methods","method":"GET","path":"/v1/delivery-methods","operation_id":"listDeliveryMethods","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/delivery-methods","method":"POST","path":"/v1/delivery-methods","operation_id":"createDeliveryMethod","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/delivery-methods/{delivery_method_id}","method":"DELETE","path":"/v1/delivery-methods/{delivery_method_id}","operation_id":"deleteDeliveryMethod","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/delivery-methods/{delivery_method_id}","method":"GET","path":"/v1/delivery-methods/{delivery_method_id}","operation_id":"getDeliveryMethod","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/delivery-methods/{delivery_method_id}","method":"PATCH","path":"/v1/delivery-methods/{delivery_method_id}","operation_id":"updateDeliveryMethod","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/delivery-previews","method":"POST","path":"/v1/delivery-previews","operation_id":"createDeliveryPreview","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/delivery-profiles","method":"GET","path":"/v1/delivery-profiles","operation_id":"listDeliveryProfiles","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/delivery-profiles","method":"POST","path":"/v1/delivery-profiles","operation_id":"createDeliveryProfile","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/delivery-profiles/{delivery_profile_id}","method":"DELETE","path":"/v1/delivery-profiles/{delivery_profile_id}","operation_id":"deleteDeliveryProfile","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/delivery-profiles/{delivery_profile_id}","method":"GET","path":"/v1/delivery-profiles/{delivery_profile_id}","operation_id":"getDeliveryProfile","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/delivery-profiles/{delivery_profile_id}","method":"PATCH","path":"/v1/delivery-profiles/{delivery_profile_id}","operation_id":"updateDeliveryProfile","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/delivery-profiles/{delivery_profile_id}/assign-to-unconfigured","method":"POST","path":"/v1/delivery-profiles/{delivery_profile_id}/assign-to-unconfigured","operation_id":"assignToUnconfiguredDeliveryProfile","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/delivery-quotes","method":"GET","path":"/v1/delivery-quotes","operation_id":"listDeliveryQuotes","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/delivery-rate-callbacks","method":"GET","path":"/v1/delivery-rate-callbacks","operation_id":"listDeliveryRateCallbacks","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/delivery-rate-callbacks","method":"POST","path":"/v1/delivery-rate-callbacks","operation_id":"createDeliveryRateCallback","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/delivery-rate-callbacks/{delivery_rate_callback_id}","method":"DELETE","path":"/v1/delivery-rate-callbacks/{delivery_rate_callback_id}","operation_id":"deleteDeliveryRateCallback","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/delivery-rate-callbacks/{delivery_rate_callback_id}","method":"GET","path":"/v1/delivery-rate-callbacks/{delivery_rate_callback_id}","operation_id":"getDeliveryRateCallback","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/delivery-rate-callbacks/{delivery_rate_callback_id}","method":"PATCH","path":"/v1/delivery-rate-callbacks/{delivery_rate_callback_id}","operation_id":"updateDeliveryRateCallback","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/delivery-rate-callbacks/{delivery_rate_callback_id}/check-connection","method":"POST","path":"/v1/delivery-rate-callbacks/{delivery_rate_callback_id}/check-connection","operation_id":"checkDeliveryRateCallbackConnection","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/delivery-rate-callbacks/{delivery_rate_callback_id}/rotate-secret","method":"POST","path":"/v1/delivery-rate-callbacks/{delivery_rate_callback_id}/rotate-secret","operation_id":"rotateDeliveryRateCallbackSigningKey","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/delivery-rate-callbacks/{delivery_rate_callback_id}/test-deliveries","method":"POST","path":"/v1/delivery-rate-callbacks/{delivery_rate_callback_id}/test-deliveries","operation_id":"createDeliveryRateCallbackTestDelivery","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/delivery-revocations","method":"POST","path":"/v1/delivery-revocations","operation_id":"revokeDeliveryDependency","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/delivery-revocations/{delivery_revocation_id}","method":"GET","path":"/v1/delivery-revocations/{delivery_revocation_id}","operation_id":"getDeliveryRevocation","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/delivery-zones","method":"GET","path":"/v1/delivery-zones","operation_id":"listDeliveryZones","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/delivery-zones","method":"POST","path":"/v1/delivery-zones","operation_id":"createDeliveryZone","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/delivery-zones/{delivery_zone_id}","method":"DELETE","path":"/v1/delivery-zones/{delivery_zone_id}","operation_id":"deleteDeliveryZone","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/delivery-zones/{delivery_zone_id}","method":"GET","path":"/v1/delivery-zones/{delivery_zone_id}","operation_id":"getDeliveryZone","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/delivery-zones/{delivery_zone_id}","method":"PATCH","path":"/v1/delivery-zones/{delivery_zone_id}","operation_id":"updateDeliveryZone","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/demo-sessions","method":"POST","path":"/v1/demo-sessions","operation_id":"createDemoSession","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/demo-sessions/reset","method":"POST","path":"/v1/demo-sessions/reset","operation_id":"resetDemoSession","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/developer/auth-context","method":"GET","path":"/v1/developer/auth-context","operation_id":"getDeveloperAuthContext","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/developer/partner/apps","method":"GET","path":"/v1/developer/partner/apps","operation_id":"listDeveloperPartnerApps","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/developer/partner/apps","method":"POST","path":"/v1/developer/partner/apps","operation_id":"createDeveloperPartnerApp","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/developer/partner/apps/{partner_app_id}","method":"GET","path":"/v1/developer/partner/apps/{partner_app_id}","operation_id":"getDeveloperPartnerApp","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/developer/partner/apps/{partner_app_id}","method":"PATCH","path":"/v1/developer/partner/apps/{partner_app_id}","operation_id":"updateDeveloperPartnerApp","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/developer/partner/apps/{partner_app_id}/installs","method":"GET","path":"/v1/developer/partner/apps/{partner_app_id}/installs","operation_id":"listDeveloperPartnerAppInstalls","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/developer/partner/apps/{partner_app_id}/installs/{partner_app_install_id}","method":"GET","path":"/v1/developer/partner/apps/{partner_app_id}/installs/{partner_app_install_id}","operation_id":"getDeveloperPartnerAppInstall","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/developer/partner/apps/{partner_app_id}/installs/{partner_app_install_id}/environment-grants/{environment_grant_id}/revoke","method":"POST","path":"/v1/developer/partner/apps/{partner_app_id}/installs/{partner_app_install_id}/environment-grants/{environment_grant_id}/revoke","operation_id":"revokeDeveloperPartnerEnvironmentGrant","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/developer/partner/apps/{partner_app_id}/installs/{partner_app_install_id}/revoke","method":"POST","path":"/v1/developer/partner/apps/{partner_app_id}/installs/{partner_app_install_id}/revoke","operation_id":"revokeDeveloperPartnerAppInstall","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/developer/partner/apps/{partner_app_id}/rotate-secret","method":"POST","path":"/v1/developer/partner/apps/{partner_app_id}/rotate-secret","operation_id":"rotateDeveloperPartnerAppSecret","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/developer/request-logs","method":"GET","path":"/v1/developer/request-logs","operation_id":"listCurrentAPIKeyRequestLogs","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/developer/request-logs/{api_request_log_id}","method":"GET","path":"/v1/developer/request-logs/{api_request_log_id}","operation_id":"getCurrentAPIKeyRequestLog","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/developer/resource-timelines/{resource_id}","method":"GET","path":"/v1/developer/resource-timelines/{resource_id}","operation_id":"getResourceTimeline","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/developer/sandboxes","method":"GET","path":"/v1/developer/sandboxes","operation_id":"listDeveloperSandboxes","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/developer/sandboxes","method":"POST","path":"/v1/developer/sandboxes","operation_id":"createDeveloperSandbox","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/developer/sandboxes/{sandbox_id}","method":"DELETE","path":"/v1/developer/sandboxes/{sandbox_id}","operation_id":"deleteDeveloperSandbox","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/developer/sandboxes/{sandbox_id}","method":"GET","path":"/v1/developer/sandboxes/{sandbox_id}","operation_id":"getDeveloperSandbox","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/developer/sandboxes/{sandbox_id}/reset","method":"POST","path":"/v1/developer/sandboxes/{sandbox_id}/reset","operation_id":"resetDeveloperSandbox","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/developer/sandboxes/{sandbox_id}/test-key","method":"POST","path":"/v1/developer/sandboxes/{sandbox_id}/test-key","operation_id":"issueDeveloperSandboxTestKey","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/devices","method":"GET","path":"/v1/devices","operation_id":"listDevices","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/devices","method":"POST","path":"/v1/devices","operation_id":"createDevice","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/devices/{device_id}","method":"DELETE","path":"/v1/devices/{device_id}","operation_id":"deleteDevice","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/devices/{device_id}","method":"GET","path":"/v1/devices/{device_id}","operation_id":"getDevice","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/devices/{device_id}","method":"PATCH","path":"/v1/devices/{device_id}","operation_id":"updateDevice","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/disputes","method":"GET","path":"/v1/disputes","operation_id":"listDisputes","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/disputes/{dispute_id}","method":"GET","path":"/v1/disputes/{dispute_id}","operation_id":"getDispute","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/feedback-reports","method":"GET","path":"/v1/feedback-reports","operation_id":"listFeedbackReports","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/feedback-reports","method":"POST","path":"/v1/feedback-reports","operation_id":"createFeedbackReport","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/feedback-reports/{feedback_report_id}","method":"GET","path":"/v1/feedback-reports/{feedback_report_id}","operation_id":"getFeedbackReport","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/fraud-warnings","method":"GET","path":"/v1/fraud-warnings","operation_id":"listFraudWarnings","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/fraud-warnings/{fraud_warning_id}","method":"GET","path":"/v1/fraud-warnings/{fraud_warning_id}","operation_id":"getFraudWarning","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/fulfillment-events","method":"GET","path":"/v1/fulfillment-events","operation_id":"listFulfillmentEvents","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/fulfillment-events/{fulfillment_event_id}","method":"GET","path":"/v1/fulfillment-events/{fulfillment_event_id}","operation_id":"getFulfillmentEvent","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/fulfillment-notifications","method":"GET","path":"/v1/fulfillment-notifications","operation_id":"listFulfillmentNotifications","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/fulfillment-notifications/{fulfillment_notification_id}","method":"GET","path":"/v1/fulfillment-notifications/{fulfillment_notification_id}","operation_id":"getFulfillmentNotification","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/fulfillments","method":"GET","path":"/v1/fulfillments","operation_id":"listFulfillments","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/fulfillments/{fulfillment_id}","method":"GET","path":"/v1/fulfillments/{fulfillment_id}","operation_id":"getFulfillment","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/fulfillments/{fulfillment_id}","method":"PATCH","path":"/v1/fulfillments/{fulfillment_id}","operation_id":"updateFulfillment","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/fulfillments/{fulfillment_id}/events","method":"POST","path":"/v1/fulfillments/{fulfillment_id}/events","operation_id":"createFulfillmentEvent","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/fulfillments/{fulfillment_id}/shipments","method":"POST","path":"/v1/fulfillments/{fulfillment_id}/shipments","operation_id":"createShipment","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/fulfillments/{fulfillment_id}/transitions","method":"POST","path":"/v1/fulfillments/{fulfillment_id}/transitions","operation_id":"transitionFulfillment","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/inventory-adjustments","method":"GET","path":"/v1/inventory-adjustments","operation_id":"listInventoryAdjustments","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/inventory-adjustments","method":"POST","path":"/v1/inventory-adjustments","operation_id":"createInventoryAdjustment","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/inventory-allocation-policies","method":"GET","path":"/v1/inventory-allocation-policies","operation_id":"listInventoryAllocationPolicies","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/inventory-allocation-policies","method":"POST","path":"/v1/inventory-allocation-policies","operation_id":"createInventoryAllocationPolicy","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/inventory-allocation-policies/{inventory_allocation_policy_id}","method":"DELETE","path":"/v1/inventory-allocation-policies/{inventory_allocation_policy_id}","operation_id":"deleteInventoryAllocationPolicy","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/inventory-allocation-policies/{inventory_allocation_policy_id}","method":"PATCH","path":"/v1/inventory-allocation-policies/{inventory_allocation_policy_id}","operation_id":"updateInventoryAllocationPolicy","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/inventory-counts","method":"GET","path":"/v1/inventory-counts","operation_id":"listInventoryCounts","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/inventory-counts","method":"POST","path":"/v1/inventory-counts","operation_id":"createInventoryCount","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/inventory-counts/{inventory_count_id}","method":"PATCH","path":"/v1/inventory-counts/{inventory_count_id}","operation_id":"updateInventoryCount","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/inventory-counts/{inventory_count_id}/apply","method":"POST","path":"/v1/inventory-counts/{inventory_count_id}/apply","operation_id":"applyInventoryCount","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/inventory-counts/{inventory_count_id}/cancel","method":"POST","path":"/v1/inventory-counts/{inventory_count_id}/cancel","operation_id":"cancelInventoryCount","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/inventory-items","method":"GET","path":"/v1/inventory-items","operation_id":"listInventoryItems","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/inventory-items","method":"POST","path":"/v1/inventory-items","operation_id":"createInventoryItem","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/inventory-items/{inventory_item_id}","method":"DELETE","path":"/v1/inventory-items/{inventory_item_id}","operation_id":"deleteInventoryItem","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/inventory-items/{inventory_item_id}","method":"PATCH","path":"/v1/inventory-items/{inventory_item_id}","operation_id":"updateInventoryItem","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/inventory-levels","method":"GET","path":"/v1/inventory-levels","operation_id":"listInventoryLevels","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/inventory-levels/{inventory_level_id}","method":"PATCH","path":"/v1/inventory-levels/{inventory_level_id}","operation_id":"updateInventoryLevel","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/inventory-movements","method":"GET","path":"/v1/inventory-movements","operation_id":"listInventoryMovements","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/inventory-receipts","method":"GET","path":"/v1/inventory-receipts","operation_id":"listInventoryReceipts","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/inventory-receipts","method":"POST","path":"/v1/inventory-receipts","operation_id":"createInventoryReceipt","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/inventory-reservations","method":"GET","path":"/v1/inventory-reservations","operation_id":"listInventoryReservations","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/inventory-reservations","method":"POST","path":"/v1/inventory-reservations","operation_id":"createInventoryReservation","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/inventory-reservations/{inventory_reservation_id}/commit","method":"POST","path":"/v1/inventory-reservations/{inventory_reservation_id}/commit","operation_id":"commitInventoryReservation","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/inventory-reservations/{inventory_reservation_id}/consume","method":"POST","path":"/v1/inventory-reservations/{inventory_reservation_id}/consume","operation_id":"consumeInventoryReservation","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/inventory-reservations/{inventory_reservation_id}/release","method":"POST","path":"/v1/inventory-reservations/{inventory_reservation_id}/release","operation_id":"releaseInventoryReservation","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/inventory-transfers","method":"GET","path":"/v1/inventory-transfers","operation_id":"listInventoryTransfers","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/inventory-transfers","method":"POST","path":"/v1/inventory-transfers","operation_id":"createInventoryTransfer","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/inventory-transfers/{inventory_transfer_id}","method":"PATCH","path":"/v1/inventory-transfers/{inventory_transfer_id}","operation_id":"updateInventoryTransfer","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/inventory-transfers/{inventory_transfer_id}/transitions","method":"POST","path":"/v1/inventory-transfers/{inventory_transfer_id}/transitions","operation_id":"transitionInventoryTransfer","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/invoice-payment-terms","method":"GET","path":"/v1/invoice-payment-terms","operation_id":"listInvoicePaymentTerms","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/invoice-payment-terms","method":"POST","path":"/v1/invoice-payment-terms","operation_id":"createInvoicePaymentTerm","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/invoice-payment-terms/{invoice_payment_term_id}","method":"DELETE","path":"/v1/invoice-payment-terms/{invoice_payment_term_id}","operation_id":"deleteInvoicePaymentTerm","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/invoice-payment-terms/{invoice_payment_term_id}","method":"GET","path":"/v1/invoice-payment-terms/{invoice_payment_term_id}","operation_id":"getInvoicePaymentTerm","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/invoice-payment-terms/{invoice_payment_term_id}","method":"PATCH","path":"/v1/invoice-payment-terms/{invoice_payment_term_id}","operation_id":"updateInvoicePaymentTerm","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/invoices","method":"GET","path":"/v1/invoices","operation_id":"listInvoices","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/invoices","method":"POST","path":"/v1/invoices","operation_id":"createInvoice","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/invoices/{invoice_id}","method":"GET","path":"/v1/invoices/{invoice_id}","operation_id":"getInvoice","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/invoices/{invoice_id}","method":"PATCH","path":"/v1/invoices/{invoice_id}","operation_id":"updateInvoice","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/invoices/{invoice_id}/checkout-session","method":"POST","path":"/v1/invoices/{invoice_id}/checkout-session","operation_id":"getOrCreateInvoiceCheckoutSession","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/invoices/{invoice_id}/collect","method":"POST","path":"/v1/invoices/{invoice_id}/collect","operation_id":"collectInvoice","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/invoices/{invoice_id}/delivery-attempts","method":"GET","path":"/v1/invoices/{invoice_id}/delivery-attempts","operation_id":"listInvoiceDeliveryAttempts","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/invoices/{invoice_id}/events","method":"GET","path":"/v1/invoices/{invoice_id}/events","operation_id":"listInvoiceEvents","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/invoices/{invoice_id}/issue","method":"POST","path":"/v1/invoices/{invoice_id}/issue","operation_id":"issueInvoice","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/invoices/{invoice_id}/late-fees","method":"POST","path":"/v1/invoices/{invoice_id}/late-fees","operation_id":"assessInvoiceLateFee","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/invoices/{invoice_id}/late-fees/{invoice_late_fee_id}/waive","method":"POST","path":"/v1/invoices/{invoice_id}/late-fees/{invoice_late_fee_id}/waive","operation_id":"waiveInvoiceLateFee","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/invoices/{invoice_id}/manual-payments","method":"POST","path":"/v1/invoices/{invoice_id}/manual-payments","operation_id":"recordManualInvoicePayment","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/invoices/{invoice_id}/manual-payments/reverse","method":"POST","path":"/v1/invoices/{invoice_id}/manual-payments/reverse","operation_id":"reverseManualInvoicePayment","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/invoices/{invoice_id}/mark-uncollectible","method":"POST","path":"/v1/invoices/{invoice_id}/mark-uncollectible","operation_id":"markInvoiceUncollectible","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/invoices/{invoice_id}/pause-reminders","method":"POST","path":"/v1/invoices/{invoice_id}/pause-reminders","operation_id":"pauseInvoiceReminders","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/invoices/{invoice_id}/payment-attempts","method":"GET","path":"/v1/invoices/{invoice_id}/payment-attempts","operation_id":"listInvoicePaymentAttempts","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/invoices/{invoice_id}/payment-attempts/{invoice_payment_attempt_id}","method":"GET","path":"/v1/invoices/{invoice_id}/payment-attempts/{invoice_payment_attempt_id}","operation_id":"getInvoicePaymentAttempt","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/invoices/{invoice_id}/payment-attempts/{invoice_payment_attempt_id}/cancel","method":"POST","path":"/v1/invoices/{invoice_id}/payment-attempts/{invoice_payment_attempt_id}/cancel","operation_id":"cancelInvoicePaymentAttempt","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/invoices/{invoice_id}/pdf","method":"GET","path":"/v1/invoices/{invoice_id}/pdf","operation_id":"getInvoicePDF","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/invoices/{invoice_id}/regenerate-public-link","method":"POST","path":"/v1/invoices/{invoice_id}/regenerate-public-link","operation_id":"regenerateInvoicePublicLink","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/invoices/{invoice_id}/resume-reminders","method":"POST","path":"/v1/invoices/{invoice_id}/resume-reminders","operation_id":"resumeInvoiceReminders","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/invoices/{invoice_id}/send-reminder","method":"POST","path":"/v1/invoices/{invoice_id}/send-reminder","operation_id":"sendInvoiceReminder","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/invoices/{invoice_id}/void","method":"POST","path":"/v1/invoices/{invoice_id}/void","operation_id":"voidInvoice","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/locations","method":"GET","path":"/v1/locations","operation_id":"listLocations","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/locations","method":"POST","path":"/v1/locations","operation_id":"createLocation","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/locations/{location_id}","method":"DELETE","path":"/v1/locations/{location_id}","operation_id":"deleteLocation","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/locations/{location_id}","method":"GET","path":"/v1/locations/{location_id}","operation_id":"getLocation","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/locations/{location_id}","method":"PATCH","path":"/v1/locations/{location_id}","operation_id":"updateLocation","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/locations/{location_id}/geography","method":"PATCH","path":"/v1/locations/{location_id}/geography","operation_id":"publishLocationGeography","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/locations/{location_id}/inventory","method":"PATCH","path":"/v1/locations/{location_id}/inventory","operation_id":"updateLocationInventory","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me","method":"GET","path":"/v1/me","operation_id":"getMe","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/me","method":"PATCH","path":"/v1/me","operation_id":"updateMe","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/addresses","method":"GET","path":"/v1/me/addresses","operation_id":"listMeAddresses","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/me/addresses","method":"POST","path":"/v1/me/addresses","operation_id":"createMeAddress","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/me/addresses/{customer_address_id}","method":"DELETE","path":"/v1/me/addresses/{customer_address_id}","operation_id":"deleteMeAddress","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/addresses/{customer_address_id}","method":"GET","path":"/v1/me/addresses/{customer_address_id}","operation_id":"getMeAddress","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/me/addresses/{customer_address_id}","method":"PATCH","path":"/v1/me/addresses/{customer_address_id}","operation_id":"updateMeAddress","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/me/addresses/{customer_address_id}/set-default","method":"POST","path":"/v1/me/addresses/{customer_address_id}/set-default","operation_id":"setDefaultMeAddress","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/me/deletion-requests","method":"POST","path":"/v1/me/deletion-requests","operation_id":"createMeDeletionRequest","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/deletion-requests/{customer_deletion_request_id}","method":"GET","path":"/v1/me/deletion-requests/{customer_deletion_request_id}","operation_id":"getMeDeletionRequest","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/me/email-change-requests","method":"POST","path":"/v1/me/email-change-requests","operation_id":"createMeEmailChangeRequest","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/me/email-change-requests/{email_change_request_id}/confirm","method":"POST","path":"/v1/me/email-change-requests/{email_change_request_id}/confirm","operation_id":"confirmMeEmailChangeRequest","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/fulfillments","method":"GET","path":"/v1/me/fulfillments","operation_id":"listMeFulfillments","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/invoices","method":"GET","path":"/v1/me/invoices","operation_id":"listMeInvoices","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/invoices/{invoice_id}","method":"GET","path":"/v1/me/invoices/{invoice_id}","operation_id":"getMeInvoice","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/me/invoices/{invoice_id}/checkout-session","method":"POST","path":"/v1/me/invoices/{invoice_id}/checkout-session","operation_id":"createMeInvoiceCheckoutSession","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/invoices/{invoice_id}/credit-notes","method":"GET","path":"/v1/me/invoices/{invoice_id}/credit-notes","operation_id":"listMeCreditNotes","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/invoices/{invoice_id}/credit-notes/{credit_note_id}","method":"GET","path":"/v1/me/invoices/{invoice_id}/credit-notes/{credit_note_id}","operation_id":"getMeCreditNote","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/invoices/{invoice_id}/credit-notes/{credit_note_id}/pdf","method":"GET","path":"/v1/me/invoices/{invoice_id}/credit-notes/{credit_note_id}/pdf","operation_id":"getMeCreditNotePDF","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/invoices/{invoice_id}/pdf","method":"GET","path":"/v1/me/invoices/{invoice_id}/pdf","operation_id":"getMeInvoicePDF","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/orders","method":"GET","path":"/v1/me/orders","operation_id":"listMeOrders","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/orders/{order_id}","method":"GET","path":"/v1/me/orders/{order_id}","operation_id":"getMeOrder","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/orders/{order_id}/activities","method":"GET","path":"/v1/me/orders/{order_id}/activities","operation_id":"listMeOrderActivities","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/me/orders/{order_id}/receipt","method":"POST","path":"/v1/me/orders/{order_id}/receipt","operation_id":"resendMeOrderReceipt","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/packages","method":"GET","path":"/v1/me/packages","operation_id":"listMePackages","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/payment-methods","method":"GET","path":"/v1/me/payment-methods","operation_id":"listMePaymentMethods","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/me/payment-methods","method":"POST","path":"/v1/me/payment-methods","operation_id":"saveMePaymentMethod","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/me/payment-methods/{payment_method_id}","method":"DELETE","path":"/v1/me/payment-methods/{payment_method_id}","operation_id":"removeMePaymentMethod","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/me/payment-methods/{payment_method_id}/set-default","method":"POST","path":"/v1/me/payment-methods/{payment_method_id}/set-default","operation_id":"setDefaultMePaymentMethod","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/payments","method":"GET","path":"/v1/me/payments","operation_id":"listMePayments","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/refunds","method":"GET","path":"/v1/me/refunds","operation_id":"listMeRefunds","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/me/return-previews","method":"POST","path":"/v1/me/return-previews","operation_id":"createMeReturnPreview","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/me/return-resolutions/{resolution_id}/checkout-session","method":"POST","path":"/v1/me/return-resolutions/{resolution_id}/checkout-session","operation_id":"createMeReturnResolutionCheckoutSession","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/returns","method":"GET","path":"/v1/me/returns","operation_id":"listMeReturns","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/me/returns","method":"POST","path":"/v1/me/returns","operation_id":"createMeReturn","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/returns/{return_id}","method":"GET","path":"/v1/me/returns/{return_id}","operation_id":"getMeReturn","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/me/returns/{return_id}/cancel","method":"POST","path":"/v1/me/returns/{return_id}/cancel","operation_id":"cancelMeReturn","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/shipments","method":"GET","path":"/v1/me/shipments","operation_id":"listMeShipments","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/subscriptions","method":"GET","path":"/v1/me/subscriptions","operation_id":"listMeSubscriptions","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/me/subscriptions/{subscription_id}","method":"GET","path":"/v1/me/subscriptions/{subscription_id}","operation_id":"getMeSubscription","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/me/subscriptions/{subscription_id}/cancel","method":"POST","path":"/v1/me/subscriptions/{subscription_id}/cancel","operation_id":"cancelMeSubscription","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/me/subscriptions/{subscription_id}/pause","method":"POST","path":"/v1/me/subscriptions/{subscription_id}/pause","operation_id":"pauseMeSubscription","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/me/subscriptions/{subscription_id}/payment-method","method":"POST","path":"/v1/me/subscriptions/{subscription_id}/payment-method","operation_id":"changeMeSubscriptionPaymentMethod","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/me/subscriptions/{subscription_id}/reactivate","method":"POST","path":"/v1/me/subscriptions/{subscription_id}/reactivate","operation_id":"reactivateMeSubscription","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/me/subscriptions/{subscription_id}/resume","method":"POST","path":"/v1/me/subscriptions/{subscription_id}/resume","operation_id":"resumeMeSubscription","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/merchant-account-sessions","method":"POST","path":"/v1/merchant-account-sessions","operation_id":"createMerchantAccountSession","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/merchant-account-sessions/refresh","method":"POST","path":"/v1/merchant-account-sessions/refresh","operation_id":"refreshMerchantAccountSession","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/merchant-billing-balances","method":"GET","path":"/v1/merchant-billing-balances","operation_id":"listMerchantBillingBalances","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/merchant-billing-balances/{merchant_billing_balance_id}","method":"GET","path":"/v1/merchant-billing-balances/{merchant_billing_balance_id}","operation_id":"getMerchantBillingBalance","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/merchant-subscription-invoices","method":"GET","path":"/v1/merchant-subscription-invoices","operation_id":"listMerchantSubscriptionInvoices","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/merchant-subscription-invoices/{merchant_subscription_invoice_id}","method":"GET","path":"/v1/merchant-subscription-invoices/{merchant_subscription_invoice_id}","operation_id":"getMerchantSubscriptionInvoice","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/merchants/{merchant_id}","method":"GET","path":"/v1/merchants/{merchant_id}","operation_id":"getMerchant","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/merchants/{merchant_id}","method":"PATCH","path":"/v1/merchants/{merchant_id}","operation_id":"updateMerchant","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/modifier-groups","method":"GET","path":"/v1/modifier-groups","operation_id":"listModifierGroups","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/modifier-groups","method":"POST","path":"/v1/modifier-groups","operation_id":"createModifierGroup","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/modifier-groups/{modifier_group_id}","method":"DELETE","path":"/v1/modifier-groups/{modifier_group_id}","operation_id":"deleteModifierGroup","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/modifier-groups/{modifier_group_id}","method":"GET","path":"/v1/modifier-groups/{modifier_group_id}","operation_id":"getModifierGroup","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/modifier-groups/{modifier_group_id}","method":"PATCH","path":"/v1/modifier-groups/{modifier_group_id}","operation_id":"updateModifierGroup","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/modifier-sets","method":"GET","path":"/v1/modifier-sets","operation_id":"listModifierSets","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/modifier-sets","method":"POST","path":"/v1/modifier-sets","operation_id":"createModifierSet","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/modifier-sets/{modifier_set_id}","method":"DELETE","path":"/v1/modifier-sets/{modifier_set_id}","operation_id":"deleteModifierSet","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/modifier-sets/{modifier_set_id}","method":"GET","path":"/v1/modifier-sets/{modifier_set_id}","operation_id":"getModifierSet","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/modifier-sets/{modifier_set_id}","method":"PATCH","path":"/v1/modifier-sets/{modifier_set_id}","operation_id":"updateModifierSet","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/oauth/authorize","method":"GET","path":"/v1/oauth/authorize","operation_id":"authorizePartnerInstall","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/oauth/authorize/preview","method":"GET","path":"/v1/oauth/authorize/preview","operation_id":"previewPartnerInstallAuthorization","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/oauth/token","method":"POST","path":"/v1/oauth/token","operation_id":"exchangePartnerInstallToken","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/onboarding/advance","method":"POST","path":"/v1/onboarding/advance","operation_id":"advanceOnboarding","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/onboarding/api-key","method":"POST","path":"/v1/onboarding/api-key","operation_id":"createOnboardingAPIKey","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/onboarding/start","method":"POST","path":"/v1/onboarding/start","operation_id":"startOnboarding","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/onboarding/state","method":"GET","path":"/v1/onboarding/state","operation_id":"getOnboardingState","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/onboarding/verify-email","method":"POST","path":"/v1/onboarding/verify-email","operation_id":"verifyOnboardingEmail","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/openapi.json","method":"GET","path":"/v1/openapi.json","operation_id":"getOpenAPISpec","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/orders","method":"GET","path":"/v1/orders","operation_id":"listOrders","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/orders","method":"POST","path":"/v1/orders","operation_id":"createOrder","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/orders/{order_id}","method":"GET","path":"/v1/orders/{order_id}","operation_id":"getOrder","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/orders/{order_id}","method":"PATCH","path":"/v1/orders/{order_id}","operation_id":"updateOrder","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/orders/{order_id}/activities","method":"GET","path":"/v1/orders/{order_id}/activities","operation_id":"listOrderActivities","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/orders/{order_id}/charges","method":"POST","path":"/v1/orders/{order_id}/charges","operation_id":"addOrderCharge","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/orders/{order_id}/charges/{order_charge_id}","method":"DELETE","path":"/v1/orders/{order_id}/charges/{order_charge_id}","operation_id":"deleteOrderCharge","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/orders/{order_id}/charges/{order_charge_id}","method":"PATCH","path":"/v1/orders/{order_id}/charges/{order_charge_id}","operation_id":"updateOrderCharge","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/orders/{order_id}/close","method":"POST","path":"/v1/orders/{order_id}/close","operation_id":"closeOrder","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/orders/{order_id}/delivery-selections/current","method":"GET","path":"/v1/orders/{order_id}/delivery-selections/current","operation_id":"getOrderCurrentDeliverySelection","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/orders/{order_id}/discounts","method":"POST","path":"/v1/orders/{order_id}/discounts","operation_id":"applyOrderDiscount","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/orders/{order_id}/discounts/preview","method":"POST","path":"/v1/orders/{order_id}/discounts/preview","operation_id":"previewOrderDiscounts","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/orders/{order_id}/discounts/remove","method":"POST","path":"/v1/orders/{order_id}/discounts/remove","operation_id":"removeOrderDiscounts","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/orders/{order_id}/discounts/reprice","method":"POST","path":"/v1/orders/{order_id}/discounts/reprice","operation_id":"repriceOrderDiscounts","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/orders/{order_id}/fulfillments","method":"POST","path":"/v1/orders/{order_id}/fulfillments","operation_id":"createFulfillment","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/orders/{order_id}/inventory-exception/resolve","method":"POST","path":"/v1/orders/{order_id}/inventory-exception/resolve","operation_id":"resolveOrderInventoryException","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/orders/{order_id}/line-items","method":"POST","path":"/v1/orders/{order_id}/line-items","operation_id":"addOrderLineItems","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/orders/{order_id}/line-items/{order_line_item_id}","method":"DELETE","path":"/v1/orders/{order_id}/line-items/{order_line_item_id}","operation_id":"deleteOrderLineItem","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/orders/{order_id}/line-items/{order_line_item_id}","method":"PATCH","path":"/v1/orders/{order_id}/line-items/{order_line_item_id}","operation_id":"updateOrderLineItem","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/orders/{order_id}/pay","method":"POST","path":"/v1/orders/{order_id}/pay","operation_id":"payOrder","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/orders/{order_id}/payment-attempts","method":"GET","path":"/v1/orders/{order_id}/payment-attempts","operation_id":"listOrderPaymentAttempts","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/orders/{order_id}/payment-attempts/{payment_attempt_id}","method":"GET","path":"/v1/orders/{order_id}/payment-attempts/{payment_attempt_id}","operation_id":"getOrderPaymentAttempt","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/orders/{order_id}/payment-attempts/{payment_attempt_id}/cancel","method":"POST","path":"/v1/orders/{order_id}/payment-attempts/{payment_attempt_id}/cancel","operation_id":"cancelOrderPaymentAttempt","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/orders/{order_id}/payment-intents","method":"POST","path":"/v1/orders/{order_id}/payment-intents","operation_id":"createOrderPaymentIntent","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/orders/{order_id}/payment-intents/{payment_intent_id}/cancel","method":"POST","path":"/v1/orders/{order_id}/payment-intents/{payment_intent_id}/cancel","operation_id":"cancelOrderPayment","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/orders/{order_id}/payment-intents/{payment_intent_id}/capture","method":"POST","path":"/v1/orders/{order_id}/payment-intents/{payment_intent_id}/capture","operation_id":"captureOrderPayment","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/orders/{order_id}/receipt","method":"POST","path":"/v1/orders/{order_id}/receipt","operation_id":"resendOrderReceipt","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/organizations","method":"GET","path":"/v1/organizations","operation_id":"listOrganizations","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/organizations","method":"POST","path":"/v1/organizations","operation_id":"createOrganization","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/organizations/{organization_id}","method":"DELETE","path":"/v1/organizations/{organization_id}","operation_id":"deleteOrganization","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/organizations/{organization_id}","method":"GET","path":"/v1/organizations/{organization_id}","operation_id":"getOrganization","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/organizations/{organization_id}","method":"PATCH","path":"/v1/organizations/{organization_id}","operation_id":"updateOrganization","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/organizations/{organization_id}/memberships","method":"GET","path":"/v1/organizations/{organization_id}/memberships","operation_id":"listOrganizationMemberships","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/organizations/{organization_id}/memberships","method":"POST","path":"/v1/organizations/{organization_id}/memberships","operation_id":"grantOrganizationMembership","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/organizations/{organization_id}/memberships/{user_id}","method":"DELETE","path":"/v1/organizations/{organization_id}/memberships/{user_id}","operation_id":"revokeOrganizationMembership","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/organizations/{organization_id}/transfer-ownership","method":"POST","path":"/v1/organizations/{organization_id}/transfer-ownership","operation_id":"transferOrganizationOwnership","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/packages","method":"GET","path":"/v1/packages","operation_id":"listPackages","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/packages/{package_id}","method":"GET","path":"/v1/packages/{package_id}","operation_id":"getPackage","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/packages/{package_id}","method":"PATCH","path":"/v1/packages/{package_id}","operation_id":"updatePackage","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/packages/{package_id}/items","method":"GET","path":"/v1/packages/{package_id}/items","operation_id":"listPackageItems","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/packages/{package_id}/items","method":"POST","path":"/v1/packages/{package_id}/items","operation_id":"createPackageItem","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/packages/{package_id}/items/{package_item_id}","method":"DELETE","path":"/v1/packages/{package_id}/items/{package_item_id}","operation_id":"deletePackageItem","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/packages/{package_id}/items/{package_item_id}","method":"GET","path":"/v1/packages/{package_id}/items/{package_item_id}","operation_id":"getPackageItem","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/packages/{package_id}/items/{package_item_id}","method":"PATCH","path":"/v1/packages/{package_id}/items/{package_item_id}","operation_id":"updatePackageItem","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/packages/{package_id}/transitions","method":"POST","path":"/v1/packages/{package_id}/transitions","operation_id":"transitionPackage","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/packages/{package_id}/void","method":"POST","path":"/v1/packages/{package_id}/void","operation_id":"voidPackage","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/payment-intents","method":"GET","path":"/v1/payment-intents","operation_id":"listPaymentIntents","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/payment-intents","method":"POST","path":"/v1/payment-intents","operation_id":"createPaymentIntent","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/payment-intents/{payment_intent_id}","method":"GET","path":"/v1/payment-intents/{payment_intent_id}","operation_id":"getPaymentIntent","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/payment-intents/{payment_intent_id}","method":"PATCH","path":"/v1/payment-intents/{payment_intent_id}","operation_id":"updatePaymentIntent","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/payment-intents/{payment_intent_id}/cancel","method":"POST","path":"/v1/payment-intents/{payment_intent_id}/cancel","operation_id":"cancelPaymentIntent","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/payment-intents/{payment_intent_id}/capture","method":"POST","path":"/v1/payment-intents/{payment_intent_id}/capture","operation_id":"capturePaymentIntent","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/payment-intents/{payment_intent_id}/confirm","method":"POST","path":"/v1/payment-intents/{payment_intent_id}/confirm","operation_id":"confirmPaymentIntent","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/payment-links","method":"GET","path":"/v1/payment-links","operation_id":"listPaymentLinks","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/payment-links","method":"POST","path":"/v1/payment-links","operation_id":"createPaymentLink","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/payment-links/{payment_link_id}","method":"GET","path":"/v1/payment-links/{payment_link_id}","operation_id":"getPaymentLink","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/payment-links/{payment_link_id}","method":"PATCH","path":"/v1/payment-links/{payment_link_id}","operation_id":"updatePaymentLink","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/payment-links/{payment_link_id}/public","method":"GET","path":"/v1/payment-links/{payment_link_id}/public","operation_id":"getPaymentLinkPublic","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/payment-links/{payment_link_id}/resolve","method":"POST","path":"/v1/payment-links/{payment_link_id}/resolve","operation_id":"resolvePaymentLink","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/payment-method-domains","method":"GET","path":"/v1/payment-method-domains","operation_id":"listPaymentMethodDomains","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/payment-method-domains","method":"POST","path":"/v1/payment-method-domains","operation_id":"createPaymentMethodDomain","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/payment-method-domains/{payment_method_domain_id}","method":"GET","path":"/v1/payment-method-domains/{payment_method_domain_id}","operation_id":"getPaymentMethodDomain","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/payment-method-domains/{payment_method_domain_id}","method":"PATCH","path":"/v1/payment-method-domains/{payment_method_domain_id}","operation_id":"updatePaymentMethodDomain","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/payment-methods","method":"GET","path":"/v1/payment-methods","operation_id":"listPaymentMethods","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/payment-methods","method":"POST","path":"/v1/payment-methods","operation_id":"savePaymentMethod","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/payment-methods/{payment_method_id}","method":"DELETE","path":"/v1/payment-methods/{payment_method_id}","operation_id":"removePaymentMethod","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/payment-methods/{payment_method_id}","method":"GET","path":"/v1/payment-methods/{payment_method_id}","operation_id":"getPaymentMethod","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/payment-methods/{payment_method_id}/set-default","method":"POST","path":"/v1/payment-methods/{payment_method_id}/set-default","operation_id":"setDefaultPaymentMethod","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/payout-settings","method":"GET","path":"/v1/payout-settings","operation_id":"getPayoutSettings","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/payout-settings","method":"PATCH","path":"/v1/payout-settings","operation_id":"updatePayoutSettings","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/payout-settings/destinations","method":"GET","path":"/v1/payout-settings/destinations","operation_id":"listPayoutDestinations","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/payout-settings/destinations/{payout_destination_id}","method":"DELETE","path":"/v1/payout-settings/destinations/{payout_destination_id}","operation_id":"deletePayoutDestination","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/payout-settings/destinations/{payout_destination_id}","method":"GET","path":"/v1/payout-settings/destinations/{payout_destination_id}","operation_id":"getPayoutDestination","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/payout-settings/destinations/{payout_destination_id}","method":"PATCH","path":"/v1/payout-settings/destinations/{payout_destination_id}","operation_id":"updatePayoutDestination","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/payouts","method":"GET","path":"/v1/payouts","operation_id":"listPayouts","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/payouts","method":"POST","path":"/v1/payouts","operation_id":"createPayout","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/payouts/{payout_id}","method":"GET","path":"/v1/payouts/{payout_id}","operation_id":"getPayout","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/payouts/{payout_id}/cancel","method":"POST","path":"/v1/payouts/{payout_id}/cancel","operation_id":"cancelPayout","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/payouts/{payout_id}/entries","method":"GET","path":"/v1/payouts/{payout_id}/entries","operation_id":"listPayoutEntries","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/products","method":"GET","path":"/v1/products","operation_id":"listProducts","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/products","method":"POST","path":"/v1/products","operation_id":"createProduct","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/products/{product_id}","method":"DELETE","path":"/v1/products/{product_id}","operation_id":"deleteProduct","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/products/{product_id}","method":"GET","path":"/v1/products/{product_id}","operation_id":"getProduct","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/products/{product_id}","method":"PATCH","path":"/v1/products/{product_id}","operation_id":"updateProduct","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/products/{product_id}/options","method":"GET","path":"/v1/products/{product_id}/options","operation_id":"listProductOptions","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/products/{product_id}/options/{option_id}","method":"GET","path":"/v1/products/{product_id}/options/{option_id}","operation_id":"getProductOption","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/products/{product_id}/variants","method":"GET","path":"/v1/products/{product_id}/variants","operation_id":"listProductVariants","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/products/{product_id}/variants","method":"POST","path":"/v1/products/{product_id}/variants","operation_id":"createProductVariant","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/products/{product_id}/variants/{variant_id}","method":"DELETE","path":"/v1/products/{product_id}/variants/{variant_id}","operation_id":"deleteProductVariant","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/products/{product_id}/variants/{variant_id}","method":"GET","path":"/v1/products/{product_id}/variants/{variant_id}","operation_id":"getProductVariant","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/products/{product_id}/variants/{variant_id}","method":"PATCH","path":"/v1/products/{product_id}/variants/{variant_id}","operation_id":"updateProductVariant","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/promotions","method":"GET","path":"/v1/promotions","operation_id":"listPromotions","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/promotions","method":"POST","path":"/v1/promotions","operation_id":"createPromotion","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/promotions/by-code/{code}","method":"GET","path":"/v1/promotions/by-code/{code}","operation_id":"resolvePromotionCode","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/promotions/{promotion_id}","method":"DELETE","path":"/v1/promotions/{promotion_id}","operation_id":"deletePromotion","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/promotions/{promotion_id}","method":"GET","path":"/v1/promotions/{promotion_id}","operation_id":"getPromotion","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/promotions/{promotion_id}","method":"PATCH","path":"/v1/promotions/{promotion_id}","operation_id":"updatePromotion","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/promotions/{promotion_id}/codes","method":"GET","path":"/v1/promotions/{promotion_id}/codes","operation_id":"listPromotionCodes","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/promotions/{promotion_id}/codes","method":"POST","path":"/v1/promotions/{promotion_id}/codes","operation_id":"createPromotionCode","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/promotions/{promotion_id}/codes/{promotion_code_id}","method":"DELETE","path":"/v1/promotions/{promotion_id}/codes/{promotion_code_id}","operation_id":"deletePromotionCode","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/promotions/{promotion_id}/codes/{promotion_code_id}","method":"PATCH","path":"/v1/promotions/{promotion_id}/codes/{promotion_code_id}","operation_id":"updatePromotionCode","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/refunds","method":"GET","path":"/v1/refunds","operation_id":"listRefunds","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/refunds","method":"POST","path":"/v1/refunds","operation_id":"createRefund","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/refunds/{refund_id}","method":"GET","path":"/v1/refunds/{refund_id}","operation_id":"getRefund","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/refunds/{refund_id}","method":"PATCH","path":"/v1/refunds/{refund_id}","operation_id":"updateRefund","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/report-downloads/{report_download_id}","method":"GET","path":"/v1/report-downloads/{report_download_id}","operation_id":"getReportDownload","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/reports","method":"GET","path":"/v1/reports","operation_id":"listReports","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/reports","method":"POST","path":"/v1/reports","operation_id":"createReport","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/reports/{report_id}","method":"GET","path":"/v1/reports/{report_id}","operation_id":"getReport","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/return-dispositions","method":"GET","path":"/v1/return-dispositions","operation_id":"listReturnDispositions","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/return-dispositions/{return_disposition_id}","method":"GET","path":"/v1/return-dispositions/{return_disposition_id}","operation_id":"getReturnDisposition","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/return-dispositions/{return_disposition_id}/cancel","method":"POST","path":"/v1/return-dispositions/{return_disposition_id}/cancel","operation_id":"cancelReturnDisposition","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/return-dispositions/{return_disposition_id}/retry","method":"POST","path":"/v1/return-dispositions/{return_disposition_id}/retry","operation_id":"retryReturnDisposition","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/return-inspections","method":"GET","path":"/v1/return-inspections","operation_id":"listReturnInspections","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/return-inspections/{return_inspection_id}","method":"GET","path":"/v1/return-inspections/{return_inspection_id}","operation_id":"getReturnInspection","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/return-inspections/{return_inspection_id}/line-items/{return_inspection_line_item_id}/decide","method":"POST","path":"/v1/return-inspections/{return_inspection_id}/line-items/{return_inspection_line_item_id}/decide","operation_id":"decideReturnInspectionLineItem","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/return-policies","method":"GET","path":"/v1/return-policies","operation_id":"listReturnPolicies","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/return-policies","method":"POST","path":"/v1/return-policies","operation_id":"createReturnPolicy","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/return-policies/{return_policy_id}","method":"DELETE","path":"/v1/return-policies/{return_policy_id}","operation_id":"deleteReturnPolicy","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/return-policies/{return_policy_id}","method":"GET","path":"/v1/return-policies/{return_policy_id}","operation_id":"getReturnPolicy","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/return-policies/{return_policy_id}","method":"PATCH","path":"/v1/return-policies/{return_policy_id}","operation_id":"updateReturnPolicy","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/return-policies/{return_policy_id}/revisions","method":"GET","path":"/v1/return-policies/{return_policy_id}/revisions","operation_id":"listReturnPolicyRevisions","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/return-policies/{return_policy_id}/revisions","method":"POST","path":"/v1/return-policies/{return_policy_id}/revisions","operation_id":"publishReturnPolicyRevision","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/return-policies/{return_policy_id}/revisions/{return_policy_revision_id}","method":"GET","path":"/v1/return-policies/{return_policy_id}/revisions/{return_policy_revision_id}","operation_id":"getReturnPolicyRevision","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/return-previews","method":"POST","path":"/v1/return-previews","operation_id":"createReturnPreview","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/return-reasons","method":"GET","path":"/v1/return-reasons","operation_id":"listReturnReasons","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/return-reasons","method":"POST","path":"/v1/return-reasons","operation_id":"createReturnReason","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/return-reasons/{return_reason_id}","method":"DELETE","path":"/v1/return-reasons/{return_reason_id}","operation_id":"deleteReturnReason","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/return-reasons/{return_reason_id}","method":"GET","path":"/v1/return-reasons/{return_reason_id}","operation_id":"getReturnReason","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/return-reasons/{return_reason_id}","method":"PATCH","path":"/v1/return-reasons/{return_reason_id}","operation_id":"updateReturnReason","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/return-receipts","method":"GET","path":"/v1/return-receipts","operation_id":"listReturnReceipts","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/return-receipts/{return_receipt_id}","method":"GET","path":"/v1/return-receipts/{return_receipt_id}","operation_id":"getReturnReceipt","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/return-receipts/{return_receipt_id}/line-items/{return_receipt_line_item_id}/verify","method":"POST","path":"/v1/return-receipts/{return_receipt_id}/line-items/{return_receipt_line_item_id}/verify","operation_id":"verifyReturnReceiptLineItem","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/return-resolutions","method":"GET","path":"/v1/return-resolutions","operation_id":"listReturnResolutions","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/return-resolutions/{return_resolution_id}","method":"GET","path":"/v1/return-resolutions/{return_resolution_id}","operation_id":"getReturnResolution","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/return-resolutions/{return_resolution_id}","method":"PATCH","path":"/v1/return-resolutions/{return_resolution_id}","operation_id":"updateReturnResolution","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/return-resolutions/{return_resolution_id}/cancel","method":"POST","path":"/v1/return-resolutions/{return_resolution_id}/cancel","operation_id":"cancelReturnResolution","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/return-resolutions/{return_resolution_id}/checkout-session","method":"POST","path":"/v1/return-resolutions/{return_resolution_id}/checkout-session","operation_id":"getOrCreateReturnResolutionCheckoutSession","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/return-resolutions/{return_resolution_id}/confirm","method":"POST","path":"/v1/return-resolutions/{return_resolution_id}/confirm","operation_id":"confirmReturnResolution","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/return-resolutions/{return_resolution_id}/release","method":"POST","path":"/v1/return-resolutions/{return_resolution_id}/release","operation_id":"releaseReturnResolution","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/return-resolutions/{return_resolution_id}/retry","method":"POST","path":"/v1/return-resolutions/{return_resolution_id}/retry","operation_id":"retryReturnResolution","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/returns","method":"GET","path":"/v1/returns","operation_id":"listReturns","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/returns","method":"POST","path":"/v1/returns","operation_id":"createReturn","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/returns/{return_id}","method":"GET","path":"/v1/returns/{return_id}","operation_id":"getReturn","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/returns/{return_id}","method":"PATCH","path":"/v1/returns/{return_id}","operation_id":"updateReturn","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/returns/{return_id}/cancel","method":"POST","path":"/v1/returns/{return_id}/cancel","operation_id":"cancelReturn","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/returns/{return_id}/complete","method":"POST","path":"/v1/returns/{return_id}/complete","operation_id":"completeReturn","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/returns/{return_id}/decide","method":"POST","path":"/v1/returns/{return_id}/decide","operation_id":"decideReturn","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/returns/{return_id}/dispositions","method":"POST","path":"/v1/returns/{return_id}/dispositions","operation_id":"createReturnDisposition","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/returns/{return_id}/inspections","method":"POST","path":"/v1/returns/{return_id}/inspections","operation_id":"createReturnInspection","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/returns/{return_id}/line-items","method":"GET","path":"/v1/returns/{return_id}/line-items","operation_id":"listReturnLineItems","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/returns/{return_id}/line-items","method":"POST","path":"/v1/returns/{return_id}/line-items","operation_id":"addReturnLineItem","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/returns/{return_id}/line-items/{return_line_item_id}","method":"DELETE","path":"/v1/returns/{return_id}/line-items/{return_line_item_id}","operation_id":"deleteReturnLineItem","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/returns/{return_id}/line-items/{return_line_item_id}","method":"GET","path":"/v1/returns/{return_id}/line-items/{return_line_item_id}","operation_id":"getReturnLineItem","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/returns/{return_id}/line-items/{return_line_item_id}","method":"PATCH","path":"/v1/returns/{return_id}/line-items/{return_line_item_id}","operation_id":"updateReturnLineItem","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/returns/{return_id}/line-items/{return_line_item_id}/cancel","method":"POST","path":"/v1/returns/{return_id}/line-items/{return_line_item_id}/cancel","operation_id":"cancelReturnLineItem","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/returns/{return_id}/line-items/{return_line_item_id}/waive-inspection","method":"POST","path":"/v1/returns/{return_id}/line-items/{return_line_item_id}/waive-inspection","operation_id":"waiveReturnLineInspection","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/returns/{return_id}/process","method":"POST","path":"/v1/returns/{return_id}/process","operation_id":"processExistingReturn","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/returns/{return_id}/receipts","method":"POST","path":"/v1/returns/{return_id}/receipts","operation_id":"createReturnReceipt","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/returns/{return_id}/reopen","method":"POST","path":"/v1/returns/{return_id}/reopen","operation_id":"reopenReturn","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/returns/{return_id}/resolutions","method":"POST","path":"/v1/returns/{return_id}/resolutions","operation_id":"createReturnResolution","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/reviews","method":"GET","path":"/v1/reviews","operation_id":"listReviews","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/reviews/{review_id}","method":"GET","path":"/v1/reviews/{review_id}","operation_id":"getReview","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/reviews/{review_id}/approve","method":"POST","path":"/v1/reviews/{review_id}/approve","operation_id":"approveReview","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/reviews/{review_id}/decline","method":"POST","path":"/v1/reviews/{review_id}/decline","operation_id":"declineReview","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/risk-lists","method":"GET","path":"/v1/risk-lists","operation_id":"listRiskLists","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/risk-lists","method":"POST","path":"/v1/risk-lists","operation_id":"createRiskList","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/risk-lists/{risk_list_id}","method":"DELETE","path":"/v1/risk-lists/{risk_list_id}","operation_id":"deleteRiskList","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/risk-lists/{risk_list_id}","method":"GET","path":"/v1/risk-lists/{risk_list_id}","operation_id":"getRiskList","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/risk-lists/{risk_list_id}","method":"PATCH","path":"/v1/risk-lists/{risk_list_id}","operation_id":"updateRiskList","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/risk-lists/{risk_list_id}/items","method":"GET","path":"/v1/risk-lists/{risk_list_id}/items","operation_id":"listRiskListItems","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/risk-lists/{risk_list_id}/items","method":"POST","path":"/v1/risk-lists/{risk_list_id}/items","operation_id":"addRiskListItems","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/risk-lists/{risk_list_id}/items/{risk_list_item_id}","method":"DELETE","path":"/v1/risk-lists/{risk_list_id}/items/{risk_list_item_id}","operation_id":"deleteRiskListItem","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/risk-lists/{risk_list_id}/items/{risk_list_item_id}","method":"GET","path":"/v1/risk-lists/{risk_list_id}/items/{risk_list_item_id}","operation_id":"getRiskListItem","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/risk-previews","method":"POST","path":"/v1/risk-previews","operation_id":"createRiskPreview","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/risk-rules","method":"GET","path":"/v1/risk-rules","operation_id":"listRiskRules","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/risk-rules","method":"POST","path":"/v1/risk-rules","operation_id":"createRiskRule","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/risk-rules/attributes","method":"GET","path":"/v1/risk-rules/attributes","operation_id":"getRiskRuleAttributeRegistry","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/risk-rules/{risk_rule_id}","method":"DELETE","path":"/v1/risk-rules/{risk_rule_id}","operation_id":"deleteRiskRule","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/risk-rules/{risk_rule_id}","method":"GET","path":"/v1/risk-rules/{risk_rule_id}","operation_id":"getRiskRule","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/risk-rules/{risk_rule_id}","method":"PATCH","path":"/v1/risk-rules/{risk_rule_id}","operation_id":"updateRiskRule","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/settings","method":"GET","path":"/v1/settings","operation_id":"getSettings","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/settings","method":"PATCH","path":"/v1/settings","operation_id":"updateSettings","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/settings/effective","method":"GET","path":"/v1/settings/effective","operation_id":"getEffectiveSettings","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/shipments","method":"GET","path":"/v1/shipments","operation_id":"listShipments","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/shipments/{shipment_id}","method":"GET","path":"/v1/shipments/{shipment_id}","operation_id":"getShipment","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/shipments/{shipment_id}","method":"PATCH","path":"/v1/shipments/{shipment_id}","operation_id":"updateShipment","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/shipments/{shipment_id}/packages","method":"POST","path":"/v1/shipments/{shipment_id}/packages","operation_id":"createPackage","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/shipments/{shipment_id}/void","method":"POST","path":"/v1/shipments/{shipment_id}/void","operation_id":"voidShipment","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/subscription-plans","method":"GET","path":"/v1/subscription-plans","operation_id":"listSubscriptionPlans","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/subscription-plans","method":"POST","path":"/v1/subscription-plans","operation_id":"createSubscriptionPlan","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/subscription-plans/{plan_id}","method":"DELETE","path":"/v1/subscription-plans/{plan_id}","operation_id":"deleteSubscriptionPlan","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/subscription-plans/{plan_id}","method":"GET","path":"/v1/subscription-plans/{plan_id}","operation_id":"getSubscriptionPlan","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/subscription-plans/{plan_id}","method":"PATCH","path":"/v1/subscription-plans/{plan_id}","operation_id":"updateSubscriptionPlan","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/subscriptions","method":"GET","path":"/v1/subscriptions","operation_id":"listSubscriptions","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/subscriptions","method":"POST","path":"/v1/subscriptions","operation_id":"createSubscription","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/subscriptions/{subscription_id}","method":"GET","path":"/v1/subscriptions/{subscription_id}","operation_id":"getSubscription","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/subscriptions/{subscription_id}","method":"PATCH","path":"/v1/subscriptions/{subscription_id}","operation_id":"updateSubscription","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/subscriptions/{subscription_id}/billing-schedule","method":"PATCH","path":"/v1/subscriptions/{subscription_id}/billing-schedule","operation_id":"updateSubscriptionBillingSchedule","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/subscriptions/{subscription_id}/cancel","method":"POST","path":"/v1/subscriptions/{subscription_id}/cancel","operation_id":"cancelSubscription","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/subscriptions/{subscription_id}/pause","method":"POST","path":"/v1/subscriptions/{subscription_id}/pause","operation_id":"pauseSubscription","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/subscriptions/{subscription_id}/payment-method","method":"POST","path":"/v1/subscriptions/{subscription_id}/payment-method","operation_id":"changeSubscriptionPaymentMethod","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/subscriptions/{subscription_id}/payment-retries","method":"GET","path":"/v1/subscriptions/{subscription_id}/payment-retries","operation_id":"listSubscriptionPaymentRetries","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/subscriptions/{subscription_id}/payment-retries","method":"POST","path":"/v1/subscriptions/{subscription_id}/payment-retries","operation_id":"createSubscriptionPaymentRetry","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/subscriptions/{subscription_id}/payment-retries/{subscription_payment_retry_id}","method":"GET","path":"/v1/subscriptions/{subscription_id}/payment-retries/{subscription_payment_retry_id}","operation_id":"getSubscriptionPaymentRetry","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/subscriptions/{subscription_id}/reactivate","method":"POST","path":"/v1/subscriptions/{subscription_id}/reactivate","operation_id":"reactivateSubscription","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/subscriptions/{subscription_id}/resume","method":"POST","path":"/v1/subscriptions/{subscription_id}/resume","operation_id":"resumeSubscription","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/subscriptions/{subscription_id}/skip-cycle","method":"POST","path":"/v1/subscriptions/{subscription_id}/skip-cycle","operation_id":"skipSubscriptionCycle","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/webhook-deliveries/{webhook_delivery_id}","method":"GET","path":"/v1/webhook-deliveries/{webhook_delivery_id}","operation_id":"getWebhookDelivery","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/webhook-deliveries/{webhook_delivery_id}/attempts","method":"GET","path":"/v1/webhook-deliveries/{webhook_delivery_id}/attempts","operation_id":"listWebhookDeliveryAttempts","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/webhook-deliveries/{webhook_delivery_id}/resend","method":"POST","path":"/v1/webhook-deliveries/{webhook_delivery_id}/resend","operation_id":"resendWebhookDelivery","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/webhook-endpoints","method":"GET","path":"/v1/webhook-endpoints","operation_id":"listWebhookEndpoints","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/webhook-endpoints","method":"POST","path":"/v1/webhook-endpoints","operation_id":"createWebhookEndpoint","change_ids":["tax-category-names"]},{"route_pattern":"DELETE /v1/webhook-endpoints/{webhook_endpoint_id}","method":"DELETE","path":"/v1/webhook-endpoints/{webhook_endpoint_id}","operation_id":"deleteWebhookEndpoint","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/webhook-endpoints/{webhook_endpoint_id}","method":"GET","path":"/v1/webhook-endpoints/{webhook_endpoint_id}","operation_id":"getWebhookEndpoint","change_ids":["tax-category-names"]},{"route_pattern":"PATCH /v1/webhook-endpoints/{webhook_endpoint_id}","method":"PATCH","path":"/v1/webhook-endpoints/{webhook_endpoint_id}","operation_id":"updateWebhookEndpoint","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/webhook-endpoints/{webhook_endpoint_id}/rotate-secret","method":"POST","path":"/v1/webhook-endpoints/{webhook_endpoint_id}/rotate-secret","operation_id":"rotateWebhookSecret","change_ids":["tax-category-names"]},{"route_pattern":"POST /v1/webhook-endpoints/{webhook_endpoint_id}/test-events","method":"POST","path":"/v1/webhook-endpoints/{webhook_endpoint_id}/test-events","operation_id":"createWebhookTestEvent","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/webhook-event-types","method":"GET","path":"/v1/webhook-event-types","operation_id":"listWebhookEventTypes","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/webhook-events","method":"GET","path":"/v1/webhook-events","operation_id":"listWebhookEvents","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/webhook-events/stream","method":"GET","path":"/v1/webhook-events/stream","operation_id":"streamWebhookEvents","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/webhook-events/{webhook_event_id}","method":"GET","path":"/v1/webhook-events/{webhook_event_id}","operation_id":"getWebhookEvent","change_ids":["tax-category-names"]},{"route_pattern":"GET /v1/webhook-events/{webhook_event_id}/deliveries","method":"GET","path":"/v1/webhook-events/{webhook_event_id}/deliveries","operation_id":"listWebhookDeliveries","change_ids":["tax-category-names"]}]}]},"x-flint-api-version":"2026-09-07","x-flint-cli-allowed-scopes":["accounts.api_keys.read","accounts.api_keys.write","accounts.devices.read","accounts.devices.write","accounts.organizations.read","accounts.organizations.write","analytics.read","capabilities.read","checkouts.checkout_sessions.read","checkouts.checkout_sessions.write","checkouts.payment_links.read","checkouts.payment_links.write","commerce.bundles.read","commerce.bundles.write","commerce.catalog.read","commerce.catalog.write","commerce.credit_notes.read","commerce.credit_notes.write","commerce.delivery.read","commerce.delivery.write","commerce.inventory.read","commerce.inventory.write","commerce.inventory_locations.write","commerce.inventory_policies.write","commerce.inventory_reservations.write","commerce.invoices.read","commerce.invoices.write","commerce.orders.read","commerce.orders.write","commerce.products.read","commerce.products.write","commerce.promotions.read","commerce.promotions.write","commerce.refunds.read","commerce.refunds.tax_overrides.write","commerce.refunds.write","commerce.return_policies.write","commerce.return_reasons.write","commerce.returns.decisions.write","commerce.returns.operations.write","commerce.returns.process.write","commerce.returns.read","commerce.returns.resolutions.write","commerce.returns.write","commerce.subscription_plans.read","commerce.subscription_plans.write","commerce.subscriptions.read","commerce.subscriptions.write","customers.read","customers.sessions.write","customers.write","developer.feedback_reports.read","developer.feedback_reports.write","developer.partner_apps.read","developer.partner_apps.write","developer.request_logs.self.detail.read","developer.request_logs.self.read","developer.resource_timelines.read","developer.sandboxes.read","developer.sandboxes.write","merchant_billing.read","merchants.account_sessions.write","merchants.locations.read","merchants.locations.write","merchants.onboarding.read","merchants.onboarding.write","merchants.profile.read","merchants.profile.write","money_movement.balance_transactions.read","money_movement.balances.read","money_movement.payout_settings.read","money_movement.payout_settings.write","money_movement.payouts.read","money_movement.payouts.write","payments.disputes.read","payments.payment_intents.read","payments.payment_intents.write","payments.payment_method_domains.read","payments.payment_method_domains.write","payments.payment_methods.read","payments.payment_methods.write","payments.payment_options.read","reports.read","reports.write","risk.controls.write","risk.read","risk.reviews.write","settings.read","settings.write","webhooks.read","webhooks.write"],"x-flint-cli-bootstrap-scopes":["accounts.api_keys.read","accounts.api_keys.write","accounts.organizations.read","accounts.organizations.write","checkouts.checkout_sessions.read","checkouts.checkout_sessions.write","checkouts.payment_links.read","checkouts.payment_links.write","commerce.invoices.read","commerce.invoices.write","merchants.profile.read","merchants.profile.write","merchants.onboarding.read","merchants.onboarding.write","merchants.account_sessions.write","commerce.orders.read","commerce.orders.write","commerce.delivery.read","commerce.delivery.write","commerce.refunds.read","commerce.refunds.write","customers.read","customers.write","developer.request_logs.self.detail.read","developer.request_logs.self.read","developer.resource_timelines.read","payments.payment_intents.read","payments.payment_intents.write","payments.payment_methods.read","payments.payment_methods.write","payments.payment_method_domains.read","payments.payment_method_domains.write","capabilities.read","payments.payment_options.read","webhooks.read","webhooks.write"],"x-flint-webhooks":{"event_payload_schemas":{"balance.updated":{"additionalProperties":true,"properties":{"balance_id":{"type":"string"}},"required":["balance_id"],"type":"object"},"balance_transaction.created":{"$ref":"#/components/schemas/BalanceTransaction"},"balance_transaction.updated":{"$ref":"#/components/schemas/BalanceTransaction"},"capability.updated":{"additionalProperties":true,"properties":{"capability":{"type":"string"}},"required":["capability"],"type":"object"},"checkout_session.closed":{"additionalProperties":false,"properties":{"checkout_session_id":{"type":"string"},"expired_at":{"format":"date-time","type":"string"},"invoice_id":{"type":"string"},"order_id":{"type":"string"},"payment_link_id":{"type":"string"},"reason":{"enum":["api"],"type":"string","x-enum-descriptions":["Api."],"x-flint-enum":"closed"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["closed"],"type":"string","x-enum-descriptions":["Closed."],"x-flint-enum":"open"},"superseding_checkout_session_id":{"type":"string"}},"required":["checkout_session_id","status","reason","resource_updated_at"],"type":"object"},"checkout_session.completed":{"additionalProperties":true,"properties":{"checkout_session_id":{"type":"string"}},"required":["checkout_session_id"],"type":"object"},"checkout_session.expired":{"additionalProperties":false,"properties":{"checkout_session_id":{"type":"string"},"expired_at":{"format":"date-time","type":"string"},"invoice_id":{"type":"string"},"order_id":{"type":"string"},"payment_link_id":{"type":"string"},"reason":{"enum":["expired"],"type":"string","x-enum-descriptions":["Expired."],"x-flint-enum":"closed"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["expired"],"type":"string","x-enum-descriptions":["Expired."],"x-flint-enum":"open"},"superseding_checkout_session_id":{"type":"string"}},"required":["checkout_session_id","status","reason","resource_updated_at"],"type":"object"},"checkout_session.invalidated":{"additionalProperties":false,"properties":{"checkout_session_id":{"type":"string"},"expired_at":{"format":"date-time","type":"string"},"invoice_id":{"type":"string"},"order_id":{"type":"string"},"payment_link_id":{"type":"string"},"reason":{"enum":["order_mutated","superseded","invoice_paid_elsewhere","invoice_voided","invoice_uncollectible","invoice_balance_changed"],"type":"string","x-enum-descriptions":["Order mutated.","Superseded.","Invoice paid elsewhere.","Invoice voided.","Invoice uncollectible.","Invoice balance changed."],"x-flint-enum":"closed"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["invalidated"],"type":"string","x-enum-descriptions":["Invalidated."],"x-flint-enum":"open"},"superseding_checkout_session_id":{"type":"string"}},"required":["checkout_session_id","status","reason","resource_updated_at"],"type":"object"},"credit_note.allocation_created":{"$ref":"#/components/schemas/CreditNoteAllocation"},"credit_note.allocation_reversed":{"$ref":"#/components/schemas/CreditNoteAllocation"},"credit_note.created":{"$ref":"#/components/schemas/CreditNote"},"credit_note.issued":{"$ref":"#/components/schemas/CreditNote"},"credit_note.updated":{"$ref":"#/components/schemas/CreditNote"},"credit_note.voided":{"$ref":"#/components/schemas/CreditNote"},"customer.created":{"additionalProperties":true,"properties":{"customer_id":{"type":"string"}},"required":["customer_id"],"type":"object"},"customer.deletion_completed":{"additionalProperties":false,"properties":{"customer_deletion_request_id":{"type":"string"},"customer_id":{"type":"string"},"requested_at":{"format":"date-time","type":"string"},"resolved_at":{"format":"date-time","type":"string"},"retention_policy":{"enum":["retain_required_commerce_records"],"type":"string","x-enum-descriptions":["Retain required commerce records."],"x-flint-enum":"closed"},"status":{"enum":["completed"],"type":"string","x-enum-descriptions":["Completed."],"x-flint-enum":"open"}},"required":["customer_deletion_request_id","customer_id","status","retention_policy","requested_at","resolved_at"],"type":"object"},"customer.deletion_rejected":{"additionalProperties":false,"properties":{"customer_deletion_request_id":{"type":"string"},"customer_id":{"type":"string"},"requested_at":{"format":"date-time","type":"string"},"resolved_at":{"format":"date-time","type":"string"},"retention_policy":{"enum":["retain_required_commerce_records"],"type":"string","x-enum-descriptions":["Retain required commerce records."],"x-flint-enum":"closed"},"status":{"enum":["rejected"],"type":"string","x-enum-descriptions":["Rejected."],"x-flint-enum":"open"}},"required":["customer_deletion_request_id","customer_id","status","retention_policy","requested_at","resolved_at"],"type":"object"},"customer.deletion_requested":{"additionalProperties":false,"properties":{"customer_deletion_request_id":{"type":"string"},"customer_id":{"type":"string"},"requested_at":{"format":"date-time","type":"string"},"resolved_at":{"format":"date-time","type":"string"},"retention_policy":{"enum":["retain_required_commerce_records"],"type":"string","x-enum-descriptions":["Retain required commerce records."],"x-flint-enum":"closed"},"status":{"enum":["pending_review"],"type":"string","x-enum-descriptions":["Pending review."],"x-flint-enum":"open"}},"required":["customer_deletion_request_id","customer_id","status","retention_policy","requested_at"],"type":"object"},"customer.updated":{"additionalProperties":true,"properties":{"customer_id":{"type":"string"}},"required":["customer_id"],"type":"object"},"delivery_location_set.activated":{"additionalProperties":true,"type":"object"},"delivery_location_set.archived":{"additionalProperties":true,"type":"object"},"delivery_location_set.created":{"additionalProperties":true,"type":"object"},"delivery_location_set.deactivated":{"additionalProperties":true,"type":"object"},"delivery_location_set.updated":{"additionalProperties":true,"type":"object"},"delivery_method.activated":{"additionalProperties":true,"type":"object"},"delivery_method.archived":{"additionalProperties":true,"type":"object"},"delivery_method.created":{"additionalProperties":true,"type":"object"},"delivery_method.deactivated":{"additionalProperties":true,"type":"object"},"delivery_method.updated":{"additionalProperties":true,"type":"object"},"delivery_profile.activated":{"additionalProperties":true,"type":"object"},"delivery_profile.archived":{"additionalProperties":true,"type":"object"},"delivery_profile.created":{"additionalProperties":true,"type":"object"},"delivery_profile.deactivated":{"additionalProperties":true,"type":"object"},"delivery_profile.updated":{"additionalProperties":true,"type":"object"},"delivery_rate.archived":{"additionalProperties":true,"type":"object"},"delivery_rate.created":{"additionalProperties":true,"type":"object"},"delivery_rate.updated":{"additionalProperties":true,"type":"object"},"delivery_rate_callback.activated":{"additionalProperties":true,"type":"object"},"delivery_rate_callback.archived":{"additionalProperties":true,"type":"object"},"delivery_rate_callback.created":{"additionalProperties":true,"type":"object"},"delivery_rate_callback.deactivated":{"additionalProperties":true,"type":"object"},"delivery_rate_callback.updated":{"additionalProperties":true,"type":"object"},"delivery_revocation.created":{"additionalProperties":true,"type":"object"},"delivery_selection.committed":{"additionalProperties":true,"type":"object"},"delivery_zone.activated":{"additionalProperties":true,"type":"object"},"delivery_zone.archived":{"additionalProperties":true,"type":"object"},"delivery_zone.created":{"additionalProperties":true,"type":"object"},"delivery_zone.deactivated":{"additionalProperties":true,"type":"object"},"delivery_zone.updated":{"additionalProperties":true,"type":"object"},"dispute.closed":{"additionalProperties":true,"properties":{"dispute_id":{"type":"string"}},"required":["dispute_id"],"type":"object"},"dispute.created":{"additionalProperties":true,"properties":{"dispute_id":{"type":"string"}},"required":["dispute_id"],"type":"object"},"dispute.lost":{"additionalProperties":true,"properties":{"dispute_id":{"type":"string"}},"required":["dispute_id"],"type":"object"},"dispute.needs_response":{"additionalProperties":true,"properties":{"dispute_id":{"type":"string"}},"required":["dispute_id"],"type":"object"},"dispute.prevented":{"additionalProperties":true,"properties":{"dispute_id":{"type":"string"}},"required":["dispute_id"],"type":"object"},"dispute.updated":{"additionalProperties":true,"properties":{"dispute_id":{"type":"string"}},"required":["dispute_id"],"type":"object"},"dispute.warning_closed":{"additionalProperties":true,"properties":{"dispute_id":{"type":"string"}},"required":["dispute_id"],"type":"object"},"dispute.won":{"additionalProperties":true,"properties":{"dispute_id":{"type":"string"}},"required":["dispute_id"],"type":"object"},"fraud_warning.created":{"$ref":"#/components/schemas/FraudWarning"},"fraud_warning.updated":{"$ref":"#/components/schemas/FraudWarning"},"inventory.action_required":{"additionalProperties":true,"type":"object"},"inventory.count.applied":{"additionalProperties":true,"type":"object"},"inventory.level.updated":{"additionalProperties":true,"type":"object"},"inventory.receipt.created":{"additionalProperties":true,"type":"object"},"inventory.reservation.at_risk":{"additionalProperties":true,"type":"object"},"inventory.reservation.closed":{"additionalProperties":true,"type":"object"},"inventory.reservation.committed":{"additionalProperties":true,"type":"object"},"inventory.reservation.consumed":{"additionalProperties":true,"type":"object"},"inventory.reservation.created":{"additionalProperties":true,"type":"object"},"inventory.reservation.hold_expired":{"additionalProperties":true,"type":"object"},"inventory.reservation.released":{"additionalProperties":true,"type":"object"},"inventory.shortage.detected":{"additionalProperties":true,"type":"object"},"inventory.transfer.closed":{"additionalProperties":true,"type":"object"},"inventory.transfer.departed":{"additionalProperties":true,"type":"object"},"inventory.transfer.lost":{"additionalProperties":true,"type":"object"},"inventory.transfer.received":{"additionalProperties":true,"type":"object"},"inventory.transfer.returned":{"additionalProperties":true,"type":"object"},"invoice.collection_block_resolved":{"additionalProperties":false,"properties":{"collection_block_reason":{"enum":["inventory_restored"],"type":"string","x-enum-descriptions":["Inventory restored."],"x-flint-enum":"closed"},"collection_block_status":{"enum":["resolved"],"type":"string","x-enum-descriptions":["Resolved."],"x-flint-enum":"open"},"collection_block_updated_at":{"format":"date-time","type":"string"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"subscription_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","collection_block_status"],"type":"object"},"invoice.collection_blocked":{"additionalProperties":false,"properties":{"collection_block_reason":{"enum":["inventory_unavailable"],"type":"string","x-enum-descriptions":["Inventory unavailable."],"x-flint-enum":"closed"},"collection_block_status":{"enum":["inventory_blocked"],"type":"string","x-enum-descriptions":["Inventory blocked."],"x-flint-enum":"open"},"collection_block_updated_at":{"format":"date-time","type":"string"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"subscription_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","collection_block_status"],"type":"object"},"invoice.created":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at"],"type":"object"},"invoice.credited":{"additionalProperties":false,"properties":{"closed_at":{"format":"date-time","type":"string"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"credit_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","credit_money","closed_at"],"type":"object"},"invoice.delivery_failed":{"additionalProperties":true,"properties":{"invoice_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version"],"type":"object"},"invoice.delivery_succeeded":{"additionalProperties":true,"properties":{"invoice_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version"],"type":"object"},"invoice.issue_failed":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"error_code":{"type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","error_code"],"type":"object"},"invoice.issued":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","issued_at","collection_mode","delivery_mode"],"type":"object"},"invoice.late_fee_assessed":{"additionalProperties":false,"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"invoice_id":{"type":"string"},"invoice_late_fee_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_schedule_entry_id":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"$ref":"#/components/schemas/Money"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_late_fee_id","amount_money","outstanding_money"],"type":"object"},"invoice.late_fee_due":{"additionalProperties":false,"properties":{"base_outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"due_at":{"format":"date-time","type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_schedule_entry_id":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"late_fee_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"late_fee_policy":{"$ref":"#/components/schemas/InvoiceLateFeePolicy"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","due_at","late_fee_money","base_outstanding_money","late_fee_policy"],"type":"object"},"invoice.late_fee_waived":{"additionalProperties":false,"properties":{"amount_money":{"$ref":"#/components/schemas/Money"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"invoice_id":{"type":"string"},"invoice_late_fee_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_schedule_entry_id":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"$ref":"#/components/schemas/Money"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_late_fee_id","amount_money","outstanding_money"],"type":"object"},"invoice.manual_payment_recorded":{"additionalProperties":true,"properties":{"invoice_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version"],"type":"object"},"invoice.manual_payment_reversed":{"additionalProperties":true,"properties":{"invoice_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version"],"type":"object"},"invoice.marked_uncollectible":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"uncollectible_at":{"format":"date-time","type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"},"written_off_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","written_off_money","uncollectible_at"],"type":"object"},"invoice.overdue":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"due_at":{"format":"date-time","type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_schedule_entry_id":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","due_at"],"type":"object"},"invoice.paid":{"additionalProperties":true,"properties":{"invoice_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version"],"type":"object"},"invoice.partially_paid":{"additionalProperties":true,"properties":{"invoice_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version"],"type":"object"},"invoice.partially_refunded":{"additionalProperties":true,"properties":{"invoice_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version"],"type":"object"},"invoice.payment_attempt_canceled":{"additionalProperties":false,"properties":{"checkout_session_id":{"type":"string"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"expected_amount_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_payment_attempt_id":{"type":"string"},"invoice_schedule_entry_id":{"pattern":"^invse_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"payment_attempt_expires_at":{"format":"date-time","type":"string"},"payment_attempt_status":{"enum":["canceled"],"type":"string","x-enum-descriptions":["Canceled."],"x-flint-enum":"open"},"payment_attempt_updated_at":{"format":"date-time","type":"string"},"payment_intent_id":{"type":"string"},"payment_rail":{"enum":["card","ach_debit","manual"],"type":"string","x-enum-descriptions":["Card.","Ach debit.","Manual."],"x-flint-enum":"closed"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","invoice_payment_attempt_id","payment_attempt_status","payment_attempt_updated_at","payment_rail","expected_amount_money"],"type":"object"},"invoice.payment_attempt_expired":{"additionalProperties":false,"properties":{"checkout_session_id":{"type":"string"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"expected_amount_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_payment_attempt_id":{"type":"string"},"invoice_schedule_entry_id":{"pattern":"^invse_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"payment_attempt_expires_at":{"format":"date-time","type":"string"},"payment_attempt_status":{"enum":["expired"],"type":"string","x-enum-descriptions":["Expired."],"x-flint-enum":"open"},"payment_attempt_updated_at":{"format":"date-time","type":"string"},"payment_intent_id":{"type":"string"},"payment_rail":{"enum":["card","ach_debit","manual"],"type":"string","x-enum-descriptions":["Card.","Ach debit.","Manual."],"x-flint-enum":"closed"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","invoice_payment_attempt_id","payment_attempt_status","payment_attempt_updated_at","payment_rail","expected_amount_money"],"type":"object"},"invoice.payment_failed":{"additionalProperties":false,"properties":{"checkout_session_id":{"type":"string"},"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"expected_amount_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"failure_code":{"enum":["card_declined","insufficient_funds","bank_account_closed","bank_account_not_found","bank_debit_not_authorized","bank_account_restricted","bank_debit_limit_exceeded","authentication_required","payment_blocked","expired_card","incorrect_cvc","processing_error","payment_method_unavailable","payment_method_declined","payment_not_completed","payment_action_expired","payment_method_temporarily_unavailable","payment_failed"],"type":"string","x-enum-descriptions":["Card declined.","Insufficient funds.","Bank account closed.","Bank account not found.","Bank debit not authorized.","Bank account restricted.","Bank debit limit exceeded.","Authentication required.","Payment blocked.","Expired card.","Incorrect cvc.","Processing error.","Payment method unavailable.","Payment method declined.","Payment not completed.","Payment action expired.","Payment method temporarily unavailable.","Payment failed."],"x-flint-enum":"closed"},"failure_message":{"type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_payment_attempt_id":{"type":"string"},"invoice_schedule_entry_id":{"pattern":"^invse_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"payment_attempt_expires_at":{"format":"date-time","type":"string"},"payment_attempt_status":{"enum":["failed"],"type":"string","x-enum-descriptions":["Failed."],"x-flint-enum":"open"},"payment_attempt_updated_at":{"format":"date-time","type":"string"},"payment_intent_id":{"type":"string"},"payment_rail":{"enum":["card","ach_debit","manual"],"type":"string","x-enum-descriptions":["Card.","Ach debit.","Manual."],"x-flint-enum":"closed"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","invoice_payment_attempt_id","payment_attempt_status","payment_attempt_updated_at","payment_rail","expected_amount_money"],"type":"object"},"invoice.payment_processing":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"expected_amount_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"expected_settlement_at":{"format":"date-time","type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_payment_attempt_id":{"type":"string"},"invoice_schedule_entry_id":{"pattern":"^invse_[0-9A-HJKMNP-TV-Z]{26}$","type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"payment_attempt_status":{"enum":["processing"],"type":"string","x-enum-descriptions":["Processing."],"x-flint-enum":"open"},"payment_attempt_updated_at":{"format":"date-time","type":"string"},"payment_intent_id":{"type":"string"},"payment_rail":{"enum":["ach_debit"],"type":"string","x-enum-descriptions":["Ach debit."],"x-flint-enum":"closed"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","invoice_payment_attempt_id","payment_attempt_status","payment_attempt_updated_at","payment_rail","expected_amount_money"],"type":"object"},"invoice.refunded":{"additionalProperties":true,"properties":{"invoice_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version"],"type":"object"},"invoice.reminder_due":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"due_at":{"format":"date-time","type":"string"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"invoice_schedule_entry_id":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at","invoice_number","due_at","delivery_mode"],"type":"object"},"invoice.sent":{"additionalProperties":true,"properties":{"invoice_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version"],"type":"object"},"invoice.updated":{"additionalProperties":false,"properties":{"collection_mode":{"enum":["buyer_initiated","automatic","external"],"type":"string","x-enum-descriptions":["Buyer initiated.","Automatic.","External."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"delivery_mode":{"enum":["email","caller_managed"],"type":"string","x-enum-descriptions":["Email.","Caller managed."],"x-flint-enum":"closed"},"invoice_id":{"type":"string"},"invoice_number":{"type":"string"},"issued_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["draft","open","partially_paid","paid","void","uncollectible","credited"],"type":"string","x-enum-descriptions":["Draft.","Open.","Partially paid.","Paid.","Void.","Uncollectible.","Credited."],"x-flint-enum":"open"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version","status","resource_updated_at"],"type":"object"},"invoice.voided":{"additionalProperties":true,"properties":{"invoice_id":{"type":"string"},"version":{"format":"int64","minimum":1,"type":"integer"}},"required":["invoice_id","version"],"type":"object"},"merchant.readiness.updated":{"additionalProperties":false,"properties":{"business_name":{"type":"string"},"merchant_environment_id":{"type":"string"},"merchant_id":{"type":"string"},"observed_at":{"format":"date-time","type":"string"},"payments":{"additionalProperties":false,"properties":{"next_actions":{"items":{"additionalProperties":false,"properties":{"action_type":{"enum":["create_merchant_account_session"],"type":"string","x-enum-descriptions":["Create merchant account session."],"x-flint-enum":"closed"},"expires_at":{"format":"date-time","type":"string"},"url":{"type":"string"}},"required":["action_type"],"type":"object"},"type":"array"},"status":{"enum":["ready","blocked","pending","not_available","not_requested"],"type":"string","x-enum-descriptions":["Ready.","Blocked.","Pending.","Not available.","Not requested."],"x-flint-enum":"open"},"status_reason":{"enum":["requirements_due","requirements_past_due","pending_verification","disabled_by_platform_policy","service_unavailable","onboarding_not_started",null],"type":["string","null"],"x-enum-descriptions":["Requirements due.","Requirements past due.","Pending verification.","Disabled by platform policy.","Service unavailable.","Onboarding not started.","Null."],"x-flint-enum":"closed"}},"required":["status","status_reason","next_actions"],"type":"object"},"payouts":{"additionalProperties":false,"properties":{"next_actions":{"items":{"additionalProperties":false,"properties":{"action_type":{"enum":["create_merchant_account_session"],"type":"string","x-enum-descriptions":["Create merchant account session."],"x-flint-enum":"closed"},"expires_at":{"format":"date-time","type":"string"},"url":{"type":"string"}},"required":["action_type"],"type":"object"},"type":"array"},"status":{"enum":["ready","blocked","pending","not_available","not_requested"],"type":"string","x-enum-descriptions":["Ready.","Blocked.","Pending.","Not available.","Not requested."],"x-flint-enum":"open"},"status_reason":{"enum":["requirements_due","requirements_past_due","pending_verification","disabled_by_platform_policy","service_unavailable","onboarding_not_started",null],"type":["string","null"],"x-enum-descriptions":["Requirements due.","Requirements past due.","Pending verification.","Disabled by platform policy.","Service unavailable.","Onboarding not started.","Null."],"x-flint-enum":"closed"}},"required":["status","status_reason","next_actions"],"type":"object"},"requirements":{"additionalProperties":false,"properties":{"current_deadline_at":{"format":"date-time","type":["string","null"]},"currently_due":{"items":{"type":"string"},"type":"array"},"disabled_reason":{"enum":["account_attention_required","account_paused","account_rejected","account_requirements_due","account_under_review","requirements_past_due","requirements_pending_verification",null],"type":["string","null"],"x-enum-descriptions":["Account attention required.","Account paused.","Account rejected.","Account requirements due.","Account under review.","Requirements past due.","Requirements pending verification.","Null."],"x-flint-enum":"closed"},"eventually_due":{"items":{"type":"string"},"type":"array"},"past_due":{"items":{"type":"string"},"type":"array"},"pending_verification":{"items":{"type":"string"},"type":"array"}},"required":["currently_due","past_due","eventually_due","pending_verification","disabled_reason"],"type":"object"}},"required":["merchant_id","merchant_environment_id","payments","payouts","requirements","observed_at"],"type":"object"},"merchant_billing_balance.updated":{"additionalProperties":false,"properties":{"available_credit_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"merchant_billing_balance_id":{"type":"string"},"observed_at":{"format":"date-time","type":"string"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"}},"required":["merchant_billing_balance_id","outstanding_money","available_credit_money","observed_at"],"type":"object"},"merchant_subscription_invoice.issued":{"$ref":"#/components/schemas/MerchantSubscriptionInvoice"},"merchant_subscription_invoice.updated":{"$ref":"#/components/schemas/MerchantSubscriptionInvoice"},"order.closed":{"additionalProperties":false,"properties":{"customer_id":{"type":"string"},"order_id":{"type":"string"},"order_number":{"type":"string"},"payment_status":{"enum":["unpaid","partially_paid","paid"],"type":"string","x-enum-descriptions":["Unpaid.","Partially paid.","Paid."],"x-flint-enum":"open"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id","status","payment_status","refund_status","resource_updated_at"],"type":"object"},"order.created":{"additionalProperties":false,"properties":{"customer_id":{"type":"string"},"order_id":{"type":"string"},"order_number":{"type":"string"},"origin":{"enum":["virtual_terminal","payment_link","checkout","api","subscription"],"type":"string","x-enum-descriptions":["Virtual terminal.","Payment link.","Checkout.","Api.","Subscription."],"x-flint-enum":"closed"},"payment_status":{"enum":["unpaid","partially_paid","paid"],"type":"string","x-enum-descriptions":["Unpaid.","Partially paid.","Paid."],"x-flint-enum":"open"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id","status","payment_status","refund_status","resource_updated_at","origin"],"type":"object"},"order.fulfillment.completed":{"additionalProperties":false,"properties":{"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_id":{"type":"string"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"}},"required":["order_id","fulfillment_id","order","fulfillment"],"type":"object"},"order.fulfillment.created":{"additionalProperties":false,"properties":{"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_id":{"type":"string"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"}},"required":["order_id","fulfillment_id","order","fulfillment"],"type":"object"},"order.fulfillment.event.created":{"additionalProperties":false,"properties":{"fulfillment_event":{"additionalProperties":false,"properties":{"buyer_notification_behavior":{"enum":["default","suppress","request"],"type":"string","x-enum-descriptions":["Default.","Suppress.","Request."],"x-flint-enum":"closed"},"custom_details":{"additionalProperties":{"type":"string"},"type":"object"},"event_type":{"enum":["accepted","preparing","picked","packed","ready","shipped","dispatched","in_transit","out_for_delivery","delivered","delivery_attempted","tracking_updated","exception","returned","completed","canceled","failed","no_show","custom"],"type":"string","x-enum-descriptions":["Accepted.","Preparing.","Picked.","Packed.","Ready.","Shipped.","Dispatched.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Tracking updated.","Exception.","Returned.","Completed.","Canceled.","Failed.","No show.","Custom."],"x-flint-enum":"closed"},"external_event_id":{"type":"string"},"external_status":{"type":"string"},"external_system":{"type":"string"},"fulfillment_event_id":{"type":"string"},"fulfillment_id":{"type":"string"},"fulfillment_status_update_id":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"package_id":{"type":"string"},"package_status_update_id":{"type":"string"},"received_at":{"format":"date-time","type":"string"},"shipment_id":{"type":"string"},"shipment_status_update_id":{"type":"string"},"target_package_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"target_quantity_effect":{"enum":["preserve","fulfill","release"],"type":"string","x-enum-descriptions":["Preserve.","Fulfill.","Release."],"x-flint-enum":"closed"},"target_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"}},"required":["fulfillment_event_id","order_id","fulfillment_id","event_type","buyer_notification_behavior","occurred_at","received_at"],"type":"object"},"fulfillment_event_id":{"type":"string"},"fulfillment_id":{"type":"string"},"order_id":{"type":"string"}},"required":["order_id","fulfillment_id","fulfillment_event_id","fulfillment_event"],"type":"object"},"order.fulfillment.package.created":{"additionalProperties":false,"properties":{"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_id":{"type":"string"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"},"package":{"additionalProperties":false,"properties":{"carrier":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"delivered_at":{"format":"date-time","type":"string"},"dimensions":{"additionalProperties":false,"properties":{"height":{"type":"number"},"length":{"type":"number"},"unit":{"type":"string"},"width":{"type":"number"}},"required":["length","width","height","unit"],"type":"object"},"external_reference_id":{"type":"string"},"external_system":{"type":"string"},"fulfillment_id":{"type":"string"},"label_url":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"package_id":{"type":"string"},"service_code":{"type":"string"},"shipment_id":{"type":"string"},"shipped_at":{"format":"date-time","type":"string"},"status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"status_reason":{"type":"string"},"tracking_number":{"type":"string"},"tracking_url":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"weight":{"additionalProperties":false,"properties":{"unit":{"type":"string"},"value":{"type":"number"}},"required":["value","unit"],"type":"object"}},"required":["package_id","order_id","fulfillment_id","shipment_id","status","created_at","updated_at"],"type":"object"},"package_id":{"type":"string"},"shipment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"delivered_at":{"format":"date-time","type":"string"},"external_reference_id":{"type":"string"},"external_system":{"type":"string"},"fulfillment_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"shipment_id":{"type":"string"},"shipped_at":{"format":"date-time","type":"string"},"status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"updated_at":{"format":"date-time","type":"string"}},"required":["shipment_id","order_id","fulfillment_id","status","created_at","updated_at"],"type":"object"},"shipment_id":{"type":"string"}},"required":["order_id","fulfillment_id","shipment_id","package_id","order","fulfillment","shipment","package"],"type":"object"},"order.fulfillment.package.updated":{"additionalProperties":false,"properties":{"current_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_event":{"additionalProperties":false,"properties":{"buyer_notification_behavior":{"enum":["default","suppress","request"],"type":"string","x-enum-descriptions":["Default.","Suppress.","Request."],"x-flint-enum":"closed"},"custom_details":{"additionalProperties":{"type":"string"},"type":"object"},"event_type":{"enum":["accepted","preparing","picked","packed","ready","shipped","dispatched","in_transit","out_for_delivery","delivered","delivery_attempted","tracking_updated","exception","returned","completed","canceled","failed","no_show","custom"],"type":"string","x-enum-descriptions":["Accepted.","Preparing.","Picked.","Packed.","Ready.","Shipped.","Dispatched.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Tracking updated.","Exception.","Returned.","Completed.","Canceled.","Failed.","No show.","Custom."],"x-flint-enum":"closed"},"external_event_id":{"type":"string"},"external_status":{"type":"string"},"external_system":{"type":"string"},"fulfillment_event_id":{"type":"string"},"fulfillment_id":{"type":"string"},"fulfillment_status_update_id":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"package_id":{"type":"string"},"package_status_update_id":{"type":"string"},"received_at":{"format":"date-time","type":"string"},"shipment_id":{"type":"string"},"shipment_status_update_id":{"type":"string"},"target_package_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"target_quantity_effect":{"enum":["preserve","fulfill","release"],"type":"string","x-enum-descriptions":["Preserve.","Fulfill.","Release."],"x-flint-enum":"closed"},"target_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"}},"required":["fulfillment_event_id","order_id","fulfillment_id","event_type","buyer_notification_behavior","occurred_at","received_at"],"type":"object"},"fulfillment_event_id":{"type":"string"},"fulfillment_id":{"type":"string"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"},"package":{"additionalProperties":false,"properties":{"carrier":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"delivered_at":{"format":"date-time","type":"string"},"dimensions":{"additionalProperties":false,"properties":{"height":{"type":"number"},"length":{"type":"number"},"unit":{"type":"string"},"width":{"type":"number"}},"required":["length","width","height","unit"],"type":"object"},"external_reference_id":{"type":"string"},"external_system":{"type":"string"},"fulfillment_id":{"type":"string"},"label_url":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"package_id":{"type":"string"},"service_code":{"type":"string"},"shipment_id":{"type":"string"},"shipped_at":{"format":"date-time","type":"string"},"status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"status_reason":{"type":"string"},"tracking_number":{"type":"string"},"tracking_url":{"type":"string"},"updated_at":{"format":"date-time","type":"string"},"weight":{"additionalProperties":false,"properties":{"unit":{"type":"string"},"value":{"type":"number"}},"required":["value","unit"],"type":"object"}},"required":["package_id","order_id","fulfillment_id","shipment_id","status","created_at","updated_at"],"type":"object"},"package_id":{"type":"string"},"package_status_update":{"additionalProperties":false,"properties":{"buyer_notification_behavior":{"enum":["default","suppress","request"],"type":"string","x-enum-descriptions":["Default.","Suppress.","Request."],"x-flint-enum":"closed"},"created_at":{"format":"date-time","type":"string"},"current_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"fulfillment_id":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"package_id":{"type":"string"},"package_status_update_id":{"type":"string"},"previous_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"reason":{"type":"string"},"shipment_id":{"type":"string"}},"required":["package_status_update_id","order_id","fulfillment_id","shipment_id","package_id","previous_status","current_status","buyer_notification_behavior","occurred_at","created_at"],"type":"object"},"package_status_update_id":{"type":"string"},"previous_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"shipment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"delivered_at":{"format":"date-time","type":"string"},"external_reference_id":{"type":"string"},"external_system":{"type":"string"},"fulfillment_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"shipment_id":{"type":"string"},"shipped_at":{"format":"date-time","type":"string"},"status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"updated_at":{"format":"date-time","type":"string"}},"required":["shipment_id","order_id","fulfillment_id","status","created_at","updated_at"],"type":"object"},"shipment_id":{"type":"string"}},"required":["order_id","fulfillment_id","shipment_id","package_id","previous_status","current_status","package_status_update_id","order","fulfillment","shipment","package","package_status_update"],"type":"object"},"order.fulfillment.shipment.created":{"additionalProperties":false,"properties":{"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_id":{"type":"string"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"},"shipment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"delivered_at":{"format":"date-time","type":"string"},"external_reference_id":{"type":"string"},"external_system":{"type":"string"},"fulfillment_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"shipment_id":{"type":"string"},"shipped_at":{"format":"date-time","type":"string"},"status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"updated_at":{"format":"date-time","type":"string"}},"required":["shipment_id","order_id","fulfillment_id","status","created_at","updated_at"],"type":"object"},"shipment_id":{"type":"string"}},"required":["order_id","fulfillment_id","shipment_id","order","fulfillment","shipment"],"type":"object"},"order.fulfillment.shipment.updated":{"additionalProperties":false,"properties":{"current_status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_event":{"additionalProperties":false,"properties":{"buyer_notification_behavior":{"enum":["default","suppress","request"],"type":"string","x-enum-descriptions":["Default.","Suppress.","Request."],"x-flint-enum":"closed"},"custom_details":{"additionalProperties":{"type":"string"},"type":"object"},"event_type":{"enum":["accepted","preparing","picked","packed","ready","shipped","dispatched","in_transit","out_for_delivery","delivered","delivery_attempted","tracking_updated","exception","returned","completed","canceled","failed","no_show","custom"],"type":"string","x-enum-descriptions":["Accepted.","Preparing.","Picked.","Packed.","Ready.","Shipped.","Dispatched.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Tracking updated.","Exception.","Returned.","Completed.","Canceled.","Failed.","No show.","Custom."],"x-flint-enum":"closed"},"external_event_id":{"type":"string"},"external_status":{"type":"string"},"external_system":{"type":"string"},"fulfillment_event_id":{"type":"string"},"fulfillment_id":{"type":"string"},"fulfillment_status_update_id":{"type":"string"},"location":{"type":"string"},"message":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"package_id":{"type":"string"},"package_status_update_id":{"type":"string"},"received_at":{"format":"date-time","type":"string"},"shipment_id":{"type":"string"},"shipment_status_update_id":{"type":"string"},"target_package_status":{"enum":["created","packed","shipped","in_transit","out_for_delivery","delivered","delivery_attempted","exception","returned","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Out for delivery.","Delivered.","Delivery attempted.","Exception.","Returned.","Voided."],"x-flint-enum":"open"},"target_quantity_effect":{"enum":["preserve","fulfill","release"],"type":"string","x-enum-descriptions":["Preserve.","Fulfill.","Release."],"x-flint-enum":"closed"},"target_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"}},"required":["fulfillment_event_id","order_id","fulfillment_id","event_type","buyer_notification_behavior","occurred_at","received_at"],"type":"object"},"fulfillment_event_id":{"type":"string"},"fulfillment_id":{"type":"string"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"},"previous_status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"shipment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"delivered_at":{"format":"date-time","type":"string"},"external_reference_id":{"type":"string"},"external_system":{"type":"string"},"fulfillment_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"shipment_id":{"type":"string"},"shipped_at":{"format":"date-time","type":"string"},"status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"updated_at":{"format":"date-time","type":"string"}},"required":["shipment_id","order_id","fulfillment_id","status","created_at","updated_at"],"type":"object"},"shipment_id":{"type":"string"},"shipment_status_update":{"additionalProperties":false,"properties":{"buyer_notification_behavior":{"enum":["default","suppress","request"],"type":"string","x-enum-descriptions":["Default.","Suppress.","Request."],"x-flint-enum":"closed"},"created_at":{"format":"date-time","type":"string"},"current_status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"fulfillment_id":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"previous_status":{"enum":["created","packed","shipped","in_transit","delivered","exception","voided"],"type":"string","x-enum-descriptions":["Created.","Packed.","Shipped.","In transit.","Delivered.","Exception.","Voided."],"x-flint-enum":"open"},"reason":{"type":"string"},"shipment_id":{"type":"string"},"shipment_status_update_id":{"type":"string"}},"required":["shipment_status_update_id","order_id","fulfillment_id","shipment_id","previous_status","current_status","buyer_notification_behavior","occurred_at","created_at"],"type":"object"},"shipment_status_update_id":{"type":"string"}},"required":["order_id","fulfillment_id","shipment_id","previous_status","current_status","shipment_status_update_id","order","fulfillment","shipment","shipment_status_update"],"type":"object"},"order.fulfillment.status_changed":{"additionalProperties":false,"properties":{"current_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"},"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_id":{"type":"string"},"fulfillment_status_update":{"additionalProperties":false,"properties":{"buyer_notification_behavior":{"enum":["default","suppress","request"],"type":"string","x-enum-descriptions":["Default.","Suppress.","Request."],"x-flint-enum":"closed"},"created_at":{"format":"date-time","type":"string"},"current_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"},"fulfillment_id":{"type":"string"},"fulfillment_status_update_id":{"type":"string"},"occurred_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"previous_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"},"quantity_effect":{"enum":["preserve","fulfill","release"],"type":"string","x-enum-descriptions":["Preserve.","Fulfill.","Release."],"x-flint-enum":"closed"},"reason":{"type":"string"}},"required":["fulfillment_status_update_id","order_id","fulfillment_id","previous_status","current_status","quantity_effect","buyer_notification_behavior","occurred_at","created_at"],"type":"object"},"fulfillment_status_update_id":{"type":"string"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"},"previous_status":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"open"}},"required":["order_id","fulfillment_id","previous_status","current_status","fulfillment_status_update_id","order","fulfillment","fulfillment_status_update"],"type":"object"},"order.fulfillment.updated":{"additionalProperties":false,"properties":{"fulfillment":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","type":"string"},"customer_id":{"type":"string"},"device_id":{"type":"string"},"external_reference_id":{"type":"string"},"fulfillment_id":{"type":"string"},"location_id":{"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"order_id":{"type":"string"},"resource_url":{"type":"string"},"state":{"enum":["pending","on_hold","in_progress","ready","completed","canceled","failed","scheduled","accepted","preparing","picked","packed","dispatched","no_show"],"type":"string","x-enum-descriptions":["Pending.","On hold.","In progress.","Ready.","Completed.","Canceled.","Failed.","Scheduled.","Accepted.","Preparing.","Picked.","Packed.","Dispatched.","No show."],"x-flint-enum":"closed"},"type":{"enum":["shipment","pickup","local_delivery","digital","service"],"type":"string","x-enum-descriptions":["Shipment.","Pickup.","Local delivery.","Digital.","Service."],"x-flint-enum":"closed"},"updated_at":{"format":"date-time","type":"string"}},"required":["fulfillment_id","resource_url","order_id","type","state","created_at","updated_at"],"type":"object"},"fulfillment_id":{"type":"string"},"order":{"additionalProperties":false,"properties":{"fulfillment_status":{"enum":["not_fulfilled","partially_fulfilled","fulfilled","canceled"],"type":"string","x-enum-descriptions":["Not fulfilled.","Partially fulfilled.","Fulfilled.","Canceled."],"x-flint-enum":"open"},"order_id":{"type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id"],"type":"object"},"order_id":{"type":"string"}},"required":["order_id","fulfillment_id","order","fulfillment"],"type":"object"},"order.inventory_action_required":{"additionalProperties":true,"properties":{"order_id":{"type":"string"}},"required":["order_id"],"type":"object"},"order.inventory_exception.created":{"additionalProperties":false,"properties":{"customer_id":{"type":"string"},"inventory_exception_reason":{"enum":["inventory_deduction_failed","auto_refund_required","auto_refund_failed","policy_resolution_failed","fulfillment_handoff_failed"],"type":"string","x-enum-descriptions":["Inventory deduction failed.","Auto refund required.","Auto refund failed.","Policy resolution failed.","Fulfillment handoff failed."],"x-flint-enum":"closed"},"inventory_exception_status":{"enum":["paid_inventory_failed"],"type":"string","x-enum-descriptions":["Paid inventory failed."],"x-flint-enum":"open"},"inventory_exception_updated_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"order_number":{"type":"string"},"payment_status":{"enum":["unpaid","partially_paid","paid"],"type":"string","x-enum-descriptions":["Unpaid.","Partially paid.","Paid."],"x-flint-enum":"open"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id","status","payment_status","refund_status","resource_updated_at","inventory_exception_status","inventory_exception_updated_at"],"type":"object"},"order.inventory_exception.resolved":{"additionalProperties":false,"properties":{"customer_id":{"type":"string"},"inventory_exception_reason":{"enum":["order_fully_refunded","resolved_by_admin"],"type":"string","x-enum-descriptions":["Order fully refunded.","Resolved by admin."],"x-flint-enum":"closed"},"inventory_exception_status":{"enum":["resolved"],"type":"string","x-enum-descriptions":["Resolved."],"x-flint-enum":"open"},"inventory_exception_updated_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"order_number":{"type":"string"},"payment_status":{"enum":["unpaid","partially_paid","paid"],"type":"string","x-enum-descriptions":["Unpaid.","Partially paid.","Paid."],"x-flint-enum":"open"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id","status","payment_status","refund_status","resource_updated_at","inventory_exception_status","inventory_exception_updated_at"],"type":"object"},"order.paid":{"additionalProperties":false,"properties":{"line_items":{"items":{"additionalProperties":false,"properties":{"base_subtotal_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"bundle_components":{"items":{"additionalProperties":false,"properties":{"component_snapshot_id":{"type":"string"},"position":{"type":"integer"},"product_id":{"type":"string"},"quantity":{"type":"integer"},"total_quantity":{"type":"integer"},"variant_id":{"type":"string"}},"required":["variant_id","product_id","quantity","position"],"type":"object"},"type":"array"},"bundle_id":{"type":"string"},"categories":{"items":{"additionalProperties":false,"properties":{"category_id":{"type":"string"},"handle":{"type":"string"},"name":{"type":"string"}},"required":["handle","name"],"type":"object"},"type":"array"},"discount_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"modifier_total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"modifiers":{"items":{"additionalProperties":false,"properties":{"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"modifier_group_name":{"type":"string"},"name":{"type":"string"},"order_line_item_modifier_id":{"type":"string"},"quantity":{"type":"integer"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"source_type":{"enum":["catalog_modifier","text"],"type":"string","x-enum-descriptions":["Catalog modifier.","Text."],"x-flint-enum":"closed"},"text_value":{"type":"string"},"total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"unit_price_delta_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"}},"required":["order_line_item_modifier_id","source_type","modifier_group_name","name","quantity","show_on_receipt","show_on_fulfillment"],"type":"object"},"type":"array"},"name":{"type":"string"},"order_line_item_id":{"type":"string"},"product_id":{"type":"string"},"quantity":{"type":"integer"},"selected_options":{"items":{"additionalProperties":false,"properties":{"option_id":{"type":"string"},"option_name":{"type":"string"},"option_value_id":{"type":"string"},"value":{"type":"string"}},"required":["option_id","option_name","option_value_id","value"],"type":"object"},"type":"array"},"source_type":{"enum":["variant","bundle"],"type":"string","x-enum-descriptions":["Variant.","Bundle."],"x-flint-enum":"closed"},"subtotal_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"tax_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"unit_price_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"variant_id":{"type":"string"}},"required":["order_line_item_id","name","quantity"],"type":"object"},"type":"array"},"order_id":{"type":"string"},"order_payment_intent_ids":{"items":{"type":"string"},"type":"array"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"paid_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"payment_status":{"enum":["paid"],"type":"string","x-enum-descriptions":["Paid."],"x-flint-enum":"open"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"},"total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"}},"required":["order_id","status","payment_status","total_money","paid_money","outstanding_money","order_payment_intent_ids","line_items"],"type":"object"},"order.partially_paid":{"additionalProperties":false,"properties":{"line_items":{"items":{"additionalProperties":false,"properties":{"base_subtotal_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"bundle_components":{"items":{"additionalProperties":false,"properties":{"component_snapshot_id":{"type":"string"},"position":{"type":"integer"},"product_id":{"type":"string"},"quantity":{"type":"integer"},"total_quantity":{"type":"integer"},"variant_id":{"type":"string"}},"required":["variant_id","product_id","quantity","position"],"type":"object"},"type":"array"},"bundle_id":{"type":"string"},"categories":{"items":{"additionalProperties":false,"properties":{"category_id":{"type":"string"},"handle":{"type":"string"},"name":{"type":"string"}},"required":["handle","name"],"type":"object"},"type":"array"},"discount_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"modifier_total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"modifiers":{"items":{"additionalProperties":false,"properties":{"metadata":{"additionalProperties":{"type":"string"},"type":"object"},"modifier_group_name":{"type":"string"},"name":{"type":"string"},"order_line_item_modifier_id":{"type":"string"},"quantity":{"type":"integer"},"show_on_fulfillment":{"type":"boolean"},"show_on_receipt":{"type":"boolean"},"source_type":{"enum":["catalog_modifier","text"],"type":"string","x-enum-descriptions":["Catalog modifier.","Text."],"x-flint-enum":"closed"},"text_value":{"type":"string"},"total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"unit_price_delta_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"}},"required":["order_line_item_modifier_id","source_type","modifier_group_name","name","quantity","show_on_receipt","show_on_fulfillment"],"type":"object"},"type":"array"},"name":{"type":"string"},"order_line_item_id":{"type":"string"},"product_id":{"type":"string"},"quantity":{"type":"integer"},"selected_options":{"items":{"additionalProperties":false,"properties":{"option_id":{"type":"string"},"option_name":{"type":"string"},"option_value_id":{"type":"string"},"value":{"type":"string"}},"required":["option_id","option_name","option_value_id","value"],"type":"object"},"type":"array"},"source_type":{"enum":["variant","bundle"],"type":"string","x-enum-descriptions":["Variant.","Bundle."],"x-flint-enum":"closed"},"subtotal_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"tax_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"unit_price_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"variant_id":{"type":"string"}},"required":["order_line_item_id","name","quantity"],"type":"object"},"type":"array"},"order_id":{"type":"string"},"order_payment_intent_ids":{"items":{"type":"string"},"type":"array"},"outstanding_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"paid_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"},"payment_status":{"enum":["partially_paid"],"type":"string","x-enum-descriptions":["Partially paid."],"x-flint-enum":"open"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"},"total_money":{"additionalProperties":false,"properties":{"amount":{"type":"integer"},"currency":{"type":"string"}},"required":["amount","currency"],"type":"object"}},"required":["order_id","status","payment_status","total_money","paid_money","outstanding_money","order_payment_intent_ids","line_items"],"type":"object"},"order.payment_authorization_canceled":{"additionalProperties":true,"properties":{"order_id":{"type":"string"}},"required":["order_id"],"type":"object"},"order.payment_authorization_expired":{"additionalProperties":true,"properties":{"order_id":{"type":"string"}},"required":["order_id"],"type":"object"},"order.payment_authorized":{"additionalProperties":true,"properties":{"order_id":{"type":"string"}},"required":["order_id"],"type":"object"},"order.payment_captured":{"additionalProperties":true,"properties":{"order_id":{"type":"string"}},"required":["order_id"],"type":"object"},"order.refunded":{"additionalProperties":true,"properties":{"order_id":{"type":"string"}},"required":["order_id"],"type":"object"},"order.updated":{"additionalProperties":false,"properties":{"customer_id":{"type":"string"},"order_id":{"type":"string"},"order_number":{"type":"string"},"payment_status":{"enum":["unpaid","partially_paid","paid"],"type":"string","x-enum-descriptions":["Unpaid.","Partially paid.","Paid."],"x-flint-enum":"open"},"refund_status":{"enum":["none","partially_refunded","refunded"],"type":"string","x-enum-descriptions":["None.","Partially refunded.","Refunded."],"x-flint-enum":"open"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["open","closed"],"type":"string","x-enum-descriptions":["Open.","Closed."],"x-flint-enum":"open"}},"required":["order_id","status","payment_status","refund_status","resource_updated_at"],"type":"object"},"payment_intent.canceled":{"additionalProperties":true,"properties":{"payment_intent_id":{"type":"string"}},"required":["payment_intent_id"],"type":"object"},"payment_intent.fulfillment_hold.updated":{"additionalProperties":false,"properties":{"fulfillment_hold":{"additionalProperties":false,"properties":{"reason":{"enum":["external_payment_hold","external_payment_hold_released"],"type":"string","x-enum-descriptions":["External payment hold.","External payment hold released."],"x-flint-enum":"closed"},"released_at":{"format":"date-time","type":"string"},"requested_at":{"format":"date-time","type":"string"},"required_action":{"enum":["pause_fulfillment","reevaluate_fulfillment"],"type":"string","x-enum-descriptions":["Pause fulfillment.","Reevaluate fulfillment."],"x-flint-enum":"closed"},"status":{"enum":["active","released"],"type":"string","x-enum-descriptions":["Active.","Released."],"x-flint-enum":"open"},"updated_at":{"format":"date-time","type":"string"}},"required":["status","reason","requested_at","updated_at","required_action"],"type":"object"},"object":{"enum":["payment_intent"],"type":"string","x-enum-descriptions":["Payment intent."],"x-flint-enum":"closed"},"order_id":{"type":"string"},"payment_intent_id":{"type":"string"}},"required":["payment_intent_id","fulfillment_hold"],"type":"object"},"payment_intent.payment_failed":{"additionalProperties":true,"properties":{"payment_intent_id":{"type":"string"}},"required":["payment_intent_id"],"type":"object"},"payment_intent.processing":{"additionalProperties":true,"properties":{"payment_intent_id":{"type":"string"}},"required":["payment_intent_id"],"type":"object"},"payment_intent.requires_action":{"additionalProperties":true,"properties":{"payment_intent_id":{"type":"string"}},"required":["payment_intent_id"],"type":"object"},"payment_intent.requires_capture":{"additionalProperties":true,"properties":{"payment_intent_id":{"type":"string"}},"required":["payment_intent_id"],"type":"object"},"payment_intent.succeeded":{"additionalProperties":true,"properties":{"payment_intent_id":{"type":"string"}},"required":["payment_intent_id"],"type":"object"},"payment_method.failed":{"additionalProperties":false,"properties":{"customer_id":{"type":"string"},"failure_code":{"enum":["card_declined","insufficient_funds","bank_account_closed","bank_account_not_found","bank_debit_not_authorized","bank_account_restricted","bank_debit_limit_exceeded","authentication_required","payment_blocked","expired_card","incorrect_cvc","processing_error","payment_method_unavailable","payment_method_declined","payment_not_completed","payment_action_expired","payment_method_temporarily_unavailable","payment_failed"],"type":"string","x-enum-descriptions":["Card declined.","Insufficient funds.","Bank account closed.","Bank account not found.","Bank debit not authorized.","Bank account restricted.","Bank debit limit exceeded.","Authentication required.","Payment blocked.","Expired card.","Incorrect cvc.","Processing error.","Payment method unavailable.","Payment method declined.","Payment not completed.","Payment action expired.","Payment method temporarily unavailable.","Payment failed."],"x-flint-enum":"closed"},"failure_message":{"type":"string"},"payment_method_id":{"type":"string"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["failed"],"type":"string","x-enum-descriptions":["Failed."],"x-flint-enum":"open"}},"required":["payment_method_id","status","resource_updated_at"],"type":"object"},"payment_method.removed":{"additionalProperties":true,"properties":{"payment_method_id":{"type":"string"}},"required":["payment_method_id"],"type":"object"},"payment_method.saved":{"additionalProperties":false,"properties":{"card_brand":{"enum":["visa","mastercard","amex","discover","diners","jcb","unionpay"],"type":"string","x-enum-descriptions":["Visa.","Mastercard.","Amex.","Discover.","Diners.","Jcb.","Unionpay."],"x-flint-enum":"closed"},"card_exp_month":{"maximum":12,"minimum":1,"type":"integer"},"card_exp_year":{"type":"integer"},"card_last4":{"type":"string"},"card_wallet":{"enum":["apple_pay","google_pay"],"type":"string","x-enum-descriptions":["Apple pay.","Google pay."],"x-flint-enum":"closed"},"customer_id":{"type":"string"},"payment_method_id":{"type":"string"},"resource_updated_at":{"format":"date-time","type":"string"},"status":{"enum":["active"],"type":"string","x-enum-descriptions":["Active."],"x-flint-enum":"open"}},"required":["payment_method_id","status","resource_updated_at"],"type":"object"},"payout.canceled":{"additionalProperties":true,"properties":{"payout_id":{"type":"string"}},"required":["payout_id"],"type":"object"},"payout.created":{"additionalProperties":true,"properties":{"payout_id":{"type":"string"}},"required":["payout_id"],"type":"object"},"payout.failed":{"additionalProperties":true,"properties":{"payout_id":{"type":"string"}},"required":["payout_id"],"type":"object"},"payout.paid":{"additionalProperties":true,"properties":{"payout_id":{"type":"string"}},"required":["payout_id"],"type":"object"},"payout.reversed":{"additionalProperties":true,"properties":{"payout_id":{"type":"string"}},"required":["payout_id"],"type":"object"},"payout.updated":{"additionalProperties":true,"properties":{"payout_id":{"type":"string"}},"required":["payout_id"],"type":"object"},"payout_destination.created":{"additionalProperties":true,"properties":{"payout_destination_id":{"type":"string"}},"required":["payout_destination_id"],"type":"object"},"payout_destination.deleted":{"additionalProperties":true,"properties":{"payout_destination_id":{"type":"string"}},"required":["payout_destination_id"],"type":"object"},"payout_destination.disabled":{"additionalProperties":true,"properties":{"payout_destination_id":{"type":"string"}},"required":["payout_destination_id"],"type":"object"},"payout_destination.updated":{"additionalProperties":true,"properties":{"payout_destination_id":{"type":"string"}},"required":["payout_destination_id"],"type":"object"},"payout_settings.updated":{"additionalProperties":true,"properties":{"payout_settings_id":{"type":"string"}},"required":["payout_settings_id"],"type":"object"},"refund.created":{"additionalProperties":true,"properties":{"refund_id":{"type":"string"},"return_id":{"type":"string"},"return_resolution_id":{"type":"string"}},"required":["refund_id"],"type":"object"},"refund.failed":{"additionalProperties":true,"properties":{"refund_id":{"type":"string"},"return_id":{"type":"string"},"return_resolution_id":{"type":"string"}},"required":["refund_id"],"type":"object"},"refund.updated":{"additionalProperties":true,"properties":{"refund_id":{"type":"string"},"return_id":{"type":"string"},"return_resolution_id":{"type":"string"}},"required":["refund_id"],"type":"object"},"report.failed":{"$ref":"#/components/schemas/Report"},"report.succeeded":{"$ref":"#/components/schemas/Report"},"return.canceled":{"additionalProperties":true,"type":"object"},"return.completed":{"additionalProperties":true,"type":"object"},"return.created":{"additionalProperties":true,"type":"object"},"return.decision_recorded":{"additionalProperties":true,"type":"object"},"return.reopened":{"additionalProperties":true,"type":"object"},"return.updated":{"additionalProperties":true,"type":"object"},"return_disposition.created":{"additionalProperties":true,"type":"object"},"return_disposition.updated":{"additionalProperties":true,"type":"object"},"return_inspection.acceptance_decided":{"additionalProperties":true,"type":"object"},"return_inspection.created":{"additionalProperties":true,"type":"object"},"return_inspection.superseded":{"additionalProperties":true,"type":"object"},"return_receipt.created":{"additionalProperties":true,"type":"object"},"return_receipt.superseded":{"additionalProperties":true,"type":"object"},"return_receipt.verified":{"additionalProperties":true,"type":"object"},"return_resolution.created":{"additionalProperties":true,"type":"object"},"return_resolution.updated":{"additionalProperties":true,"type":"object"},"review.closed":{"$ref":"#/components/schemas/Review"},"review.opened":{"$ref":"#/components/schemas/Review"},"subscription.activated":{"additionalProperties":true,"properties":{"subscription_id":{"type":"string"}},"required":["subscription_id"],"type":"object"},"subscription.canceled":{"additionalProperties":true,"properties":{"subscription_id":{"type":"string"}},"required":["subscription_id"],"type":"object"},"subscription.created":{"additionalProperties":true,"properties":{"subscription_id":{"type":"string"}},"required":["subscription_id"],"type":"object"},"subscription.dunning_exhausted":{"additionalProperties":false,"properties":{"dunning_end_action":{"enum":["cancel","pause","notify_only"],"type":"string","x-enum-descriptions":["Cancel.","Pause.","Notify only."],"x-flint-enum":"closed"},"failed_period_ended_at":{"format":"date-time","type":"string"},"failed_period_started_at":{"format":"date-time","type":"string"},"order_id":{"type":"string"},"payment_attempt_id":{"type":"string"},"resource_updated_at":{"format":"date-time","type":"string"},"scheduled_billing_at":{"format":"date-time","type":"string"},"status":{"enum":["past_due"],"type":"string","x-enum-descriptions":["Past due."],"x-flint-enum":"open"},"subscription_id":{"type":"string"}},"required":["subscription_id","status","dunning_end_action","failed_period_started_at","failed_period_ended_at","scheduled_billing_at","resource_updated_at"],"type":"object"},"subscription.past_due":{"additionalProperties":true,"properties":{"subscription_id":{"type":"string"}},"required":["subscription_id"],"type":"object"},"subscription.paused":{"additionalProperties":true,"properties":{"subscription_id":{"type":"string"}},"required":["subscription_id"],"type":"object"},"subscription.payment_failed":{"additionalProperties":true,"properties":{"order_id":{"type":"string"},"scheduled_billing_at":{"format":"date-time","type":"string"},"subscription_id":{"type":"string"}},"required":["subscription_id","scheduled_billing_at"],"type":"object"},"subscription.payment_succeeded":{"additionalProperties":true,"properties":{"subscription_id":{"type":"string"}},"required":["subscription_id"],"type":"object"},"subscription.renewal_upcoming":{"additionalProperties":false,"properties":{"next_billing_at":{"format":"date-time","type":"string"},"resource_updated_at":{"format":"date-time","type":"string"},"subscription_id":{"type":"string"}},"required":["subscription_id","next_billing_at","resource_updated_at"],"type":"object"},"subscription.resumed":{"additionalProperties":true,"properties":{"subscription_id":{"type":"string"}},"required":["subscription_id"],"type":"object"},"subscription.trial_ending":{"additionalProperties":true,"properties":{"subscription_id":{"type":"string"}},"required":["subscription_id"],"type":"object"},"subscription.updated":{"additionalProperties":false,"properties":{"changed_fields":{"items":{"type":"string"},"type":"array","uniqueItems":true},"initiated_by":{"description":"Growable actor vocabulary. Ignore values not recognized by the consumer.","type":"string"},"previous_values":{"additionalProperties":true,"type":"object"},"resource_updated_at":{"format":"date-time","type":"string"},"subscription_id":{"type":"string"}},"required":["subscription_id","changed_fields","previous_values","resource_updated_at","initiated_by"],"type":"object"}},"partner_event_payload_schemas":{"partner_app.install.created":{"$ref":"#/components/schemas/PartnerInstallEventPayload"},"partner_app.install.environment_grant.created":{"$ref":"#/components/schemas/PartnerEnvironmentGrantEventPayload"},"partner_app.install.environment_grant.revoked":{"$ref":"#/components/schemas/PartnerEnvironmentGrantEventPayload"},"partner_app.install.permissions_updated":{"$ref":"#/components/schemas/PartnerInstallEventPayload"},"partner_app.install.revoked":{"$ref":"#/components/schemas/PartnerInstallEventPayload"},"partner_app.install.updated":{"$ref":"#/components/schemas/PartnerInstallEventPayload"}},"retry_policy":{"jitter":true,"max_attempts":9,"max_jitter_percent":20,"retry_schedule_seconds":[30,120,600,3600,14400,43200,86400,108000],"timeout_seconds":10},"secret_rotation":{"overlapping_signatures":true,"previous_secret_overlap_seconds":86400},"signing":{"algorithm":"HMAC-SHA256","headers":[{"description":"Webhook event ID.","name":"webhook-id"},{"description":"Unix timestamp in seconds.","name":"webhook-timestamp"},{"description":"One or more space-separated signatures in the format v1,\u003cbase64_hmac\u003e.","name":"webhook-signature"}],"legacy_headers":["X-Flint-Signature","X-Flint-Webhook-ID","X-Flint-Event-Type","X-Flint-Webhook-Endpoint-ID"],"scheme":"standard_webhooks_v1","secret_prefix":"whsec_","signature_encoding":"base64","signed_content":"{webhook-id}.{webhook-timestamp}.{raw_body}"}}}